Class EntityModelImpl

java.lang.Object

ch.tocco.nice2.model.entity.api.DefaultModelBase

ch.tocco.nice2.model.entity.api.DefaultEntityModel

ch.tocco.nice2.model.entity.impl.entity.EntityModelImpl

All Implemented Interfaces:

EntityModel, ModelElement, ModuleTracker

public class EntityModelImpl
extends DefaultEntityModel
implements EntityModel

Constructor Summary

Constructors

Constructor	Description
EntityModelImpl()

Method Summary

Modifier and Type	Method	Description
void	addAvailableLocale(Locale locale)
void	addDocumentation(String definingModule, String documentation)	Adds documentation for the EntityModel, contributed by the defining AppModule.
void	addExtendingModule(String moduleName)
final void	addField(FieldModel niceField)	Adds a field to this entity model.
void	addRelation(RelationModel relation)
void	addSearch(EntitySearchModel search)	Adds another EntitySearchModel to this EntityModel.
Set<Locale>	getAvailableLocales()
BusinessUnitType	getBusinessUnitType()
String	getDefiningModule()	Returns the name of the nice2 module, where this model element is defined.
LinkedHashMap<String,String>	getDocumentation()	Returns the content of the documentation element of the EntityModel tag as a LinkedHashMap, divided by the AppModules extending the base EntityModel and contributing the documentation.
EntityDocumentsModel	getEntityDocumentsModel()
List<String>	getExtendingModules()	Returns a list of nice2 module names, that have contributed to this model element.
@Nullable FieldModel	getFieldByName(String name)	Get a field by its name.
@Nullable FieldModel	getFieldByName(String name, String locale)	Get a possibly multilingual field by base name and locale.
@Nullable FieldModel	getFieldByName(String name, Locale locale)
List<FieldModel>	getFields()
Integer	getIndexPriority()	Will be used as order for indexing entities.
FieldModel	getKey()
@Nullable FieldModel	getLocalizedField(String baseName, Locale locale)	Returns one field model for the field that is of type 'localized'.
LocalizedFieldMapper	getLocalizedFieldMapper()
Map<Locale, FieldModel>	getLocalizedFields(String baseName)	Returns all field models (one per system language) for the field that is of type 'localized'.
@Nullable RelationModel	getRelationByName(String name)	Get a relation by its name.
Collection<RelationModel>	getRelations()	Get all relations FROM this entity TO other entities; only one way.
Boolean	getRelevantForExport()
Collection<FieldModel>	getRemovedFields()	Returns all removed field models.
Collection<RelationModel>	getRemovedRelations()	Returns all removed field models.
EntitySearchModel	getSearch()	Get a description for how to search in this entity.
Boolean	getUseAdminCreate()
Boolean	getUseAdminDelete()
@Nullable Boolean	getUseEntityMergeAction()
@Nullable Boolean	getUseHistoryAction()
@Nullable Boolean	getUseMassMutationActions()
Boolean	getUseNiceFields()
Boolean	getUseRemoteFieldNewButton()
EntityVisualisationModel	getVisualisation()	Get an object which describes the visualisation of this entity.
WidgetEntityType	getWidgetEntityType()	Get the entity widget entity type (CMS).
Boolean	hasContentReference()	Determine whether this entity can be a content reference source.
@Nullable Boolean	hasExportAction()
Boolean	hasGenericActions()
@Nullable Boolean	hasImportAction()
boolean	hasRemovedField(String name)	Does this Entity-Model contain a removed field? A possibility to ask the configuration if something got removed.
boolean	hasRemovedRelation(String name)	Does this Entity-Model contain a removed relation? A possibility to ask the configuration if something got removed.
Boolean	hasResetInitialvaluesAction()	Determine wheter the reset initialvalues action is shown on this entity or not
boolean	isLocalizedField(String baseName)	Tells if there is a localized field with the given base name.
Boolean	isMarkable()
boolean	isOutputCenter()
void	removeField(FieldModel toRemove)
void	removeRelation(RelationModel toRemove)
void	replaceRelation(RelationModel relation)
void	setBusinessUnitType(BusinessUnitType businessUnitType)
void	setContentReference(Boolean contentReference)	Specify whether this entity can be a content reference source.
void	setDefiningModule(String name)
void	setEntityDocumentsModel(EntityDocumentsModel entityDocumentsModel)
void	setHasExportAction(Boolean hasExportAction)
void	setHasGenericActions(Boolean hasGenericActions)
void	setHasImportAction(Boolean hasImportAction)
void	setIndexPriority(Integer indexPriority)
void	setMarkable(Boolean markable)
void	setOutputCenter(boolean outputCenter)
void	setRelevantForExport(Boolean relevantForExport)
void	setResetInitialvaluesAction(Boolean resetInitialvaluesAction)	Specify whether the reset initialvalues action is shown on this entity or not
void	setUseAdminCreate(Boolean useAdminCreate)
void	setUseAdminDelete(Boolean useAdminDelete)
void	setUseEntityMergeAction(Boolean useEntityMergeAction)
void	setUseHistoryAction(Boolean useHistoryAction)
void	setUseMassMutationActions(Boolean useMassMutationActions)
void	setUseNiceFields(Boolean useNiceFields)
void	setUseRemoteFieldNewButton(Boolean useRemoteFieldNewButton)
void	setVisualisation(EntityVisualisationModel visualisation)
void	setWidgetEntityType(WidgetEntityType widgetEntityType)	Set widget entity type (CMS).

Methods inherited from class DefaultEntityModel

getEntityType, getFieldsByBaseType, getFieldsByType, getFieldsNames, getFieldsTargets, getFirstFieldOfBaseType, getFirstFieldOfType, getName, getTarget, hasField, hasRelation, isDisabled, setDisabled, setEntityType, setName, setTarget

Methods inherited from class DefaultModelBase

getAdditionalToStringInfo, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface EntityModel

getEntityType, getFieldsByBaseType, getFieldsByType, getFieldsNames, getFieldsTargets, getFirstFieldOfBaseType, getFirstFieldOfType, getLabel, getName, getTarget, hasField, hasRelation, isDisabled, requireFieldByName, requireRelationByName, setDisabled, setEntityType, setName, setTarget

Constructor Details

EntityModelImpl

public EntityModelImpl()

Method Details

getExtendingModules

public List<String> getExtendingModules()

Description copied from interface: ModuleTracker

Returns a list of nice2 module names, that have contributed to this model element.

Specified by:

getExtendingModules in interface ModuleTracker

addExtendingModule

public void addExtendingModule(String moduleName)

Specified by:

addExtendingModule in interface ModuleTracker

getDocumentation

public LinkedHashMap<String,String> getDocumentation()

Description copied from interface: EntityModel

Returns the content of the documentation element of the EntityModel tag as a LinkedHashMap, divided by the AppModules extending the base EntityModel and contributing the documentation. The contents of the map are ordered according to the loading sequence of the AppModules.

Specified by:

getDocumentation in interface EntityModel

Returns:

The LinkedHashMap contains the EntityModel's documentation tag.

addDocumentation

public void addDocumentation(String definingModule,
 String documentation)

Description copied from interface: EntityModel

Adds documentation for the EntityModel, contributed by the defining AppModule.

Specified by:

addDocumentation in interface EntityModel

Parameters:

definingModule - the string representation of the AppModule contributing the documentation

documentation - the documentation for the EntityModel

getDefiningModule

public String getDefiningModule()

Description copied from interface: ModuleTracker

Returns the name of the nice2 module, where this model element is defined.

Specified by:

getDefiningModule in interface ModuleTracker

setDefiningModule

public void setDefiningModule(String name)

Specified by:

setDefiningModule in interface ModuleTracker

addField

public final void addField(FieldModel niceField)
                    throws IllegalArgumentException

Description copied from class: DefaultEntityModel

Adds a field to this entity model.

WARNING: This implementation currently does not check for duplicates, or fields with the same name. This is currently left up to you, but might change in the future.

Specified by:

addField in interface EntityModel

Overrides:

addField in class DefaultEntityModel

Parameters:

niceField - The field to add.

Throws:

IllegalArgumentException - (unknown nice-field, unsupported property in nice-field)

getKey

public FieldModel getKey()

Specified by:

getKey in interface EntityModel

Overrides:

getKey in class DefaultEntityModel

Returns:

The primary key field.

getFields

public List<FieldModel> getFields()

Specified by:

getFields in interface EntityModel

Overrides:

getFields in class DefaultEntityModel

Returns:

The fields including those part of the primary keys (see EntityModel.getKey()).

getLocalizedFieldMapper

public LocalizedFieldMapper getLocalizedFieldMapper()

Specified by:

getLocalizedFieldMapper in interface EntityModel

getFieldByName

public @Nullable FieldModel getFieldByName(String name)

Description copied from interface: EntityModel

Get a field by its name. Note: If the field is multilingual then provide the complete name for the strategy in use, which may look something like "somename" or "somename_fr".

Specified by:

getFieldByName in interface EntityModel

Overrides:

getFieldByName in class DefaultEntityModel

Parameters:

name - The complete field's name (including possible localized suffix), not empty.

Returns:

The field, or null if this field doesn't exists!

See Also:

• FieldModel.isLocalized()

getFieldByName

public @Nullable FieldModel getFieldByName(String name,
 String locale)

Description copied from interface: EntityModel

Get a possibly multilingual field by base name and locale.

This is a shortcut for doing: EntityModel.getFieldByName( EntityModel.getLocalizedFieldMapper().getFieldName(name, locale) );

Specified by:

getFieldByName in interface EntityModel

Parameters:

name - The field's base name, not empty.

locale - Currently the 2-digit lowercase ISO-639 language code only, eg "fr" for French.

Returns:

The field, or null if this field doesn't exists (either at all or in that locale)

See Also:

• FieldModel.isLocalized()

getFieldByName

public @Nullable FieldModel getFieldByName(String name,
 Locale locale)

Specified by:

getFieldByName in interface EntityModel

addAvailableLocale

public void addAvailableLocale(Locale locale)

Specified by:

addAvailableLocale in interface EntityModel

getAvailableLocales

public Set<Locale> getAvailableLocales()

Specified by:

getAvailableLocales in interface EntityModel

isLocalizedField

public boolean isLocalizedField(String baseName)

Description copied from interface: EntityModel

Tells if there is a localized field with the given base name.

Specified by:

isLocalizedField in interface EntityModel

Parameters:

baseName - The field's base name as specified in the entity xml file, without language part.

Returns:

true If there is such a field and it is a localized one, false if there is no such field at all, or if it is not localized.

See Also:

• EntityModel.getLocalizedFields(String)
• EntityModel.getLocalizedField(String, Locale)

getLocalizedFields

public Map<Locale, FieldModel> getLocalizedFields(String baseName)
                                           throws IllegalArgumentException

Description copied from interface: EntityModel

Returns all field models (one per system language) for the field that is of type 'localized'.

Specified by:

getLocalizedFields in interface EntityModel

Parameters:

baseName - The field's base name as specified in the entity xml file, without language part.

Returns:

key = 2 letter iso language code in lower case. Not empty, no null values within.

Throws:

IllegalArgumentException - If the field is not localized, check first.

See Also:

• EntityModel.isLocalizedField(String)
• EntityModel.getLocalizedField(String, Locale)

getLocalizedField

public @Nullable FieldModel getLocalizedField(String baseName,
 Locale locale)

Description copied from interface: EntityModel

Returns one field model for the field that is of type 'localized'.

Specified by:

getLocalizedField in interface EntityModel

Parameters:

baseName - The field's base name as specified in the entity xml file, without language part.

locale - The desired language, must be one of the configured system languages (2 letter lower case iso code).

Returns:

null if there is no such field, or if it is not localized, or if there is no such language.

See Also:

• EntityModel.isLocalizedField(String)
• EntityModel.getLocalizedFields(String)

getRelations

public Collection<RelationModel> getRelations()

Description copied from interface: EntityModel

Get all relations FROM this entity TO other entities; only one way. There seems to be no method for the opposite yet.

Specified by:

getRelations in interface EntityModel

Overrides:

getRelations in class DefaultEntityModel

getRemovedFields

public Collection<FieldModel> getRemovedFields()

Description copied from interface: EntityModel

Returns all removed field models. Returns an empty collection if none exist.

Specified by:

getRemovedFields in interface EntityModel

hasRemovedField

public boolean hasRemovedField(String name)

Description copied from interface: EntityModel

Does this Entity-Model contain a removed field?
A possibility to ask the configuration if something got removed. This is imported to remove dependent stuff.

For example the field 'username' is removed on an entity. The form-system needs to know that this field is removed that the field is also removed in the form.

Specified by:

hasRemovedField in interface EntityModel

Parameters:

name - the name

Returns:

true if this field got removed during the configuration-reading-process

getRemovedRelations

public Collection<RelationModel> getRemovedRelations()

Description copied from interface: EntityModel

Returns all removed field models. Returns an empty collection if none exist.

Specified by:

getRemovedRelations in interface EntityModel

hasRemovedRelation

public boolean hasRemovedRelation(String name)

Description copied from interface: EntityModel

Does this Entity-Model contain a removed relation?
A possibility to ask the configuration if something got removed. This is importet to remove dependend stuff.

For example we remove the Field 'username' on an entity. Then the form-system need to know that this it's removed explictly and no spelling-error in the form-configuration. Then the form-system can remove the field aswell which would normally show this entity-field.

Specified by:

hasRemovedRelation in interface EntityModel

Parameters:

name - the name

Returns:

true if this field got removed during the configuration-reading-process

addRelation

public void addRelation(RelationModel relation)

Specified by:

addRelation in interface EntityModel

Overrides:

addRelation in class DefaultEntityModel

Parameters:

relation - The relation.

See Also:

• EntityModel.replaceRelation(RelationModel)

replaceRelation

public void replaceRelation(RelationModel relation)

Specified by:

replaceRelation in interface EntityModel

See Also:

• EntityModel.addRelation(RelationModel)

getRelationByName

public @Nullable RelationModel getRelationByName(String name)

Description copied from interface: EntityModel

Get a relation by its name.

Specified by:

getRelationByName in interface EntityModel

Overrides:

getRelationByName in class DefaultEntityModel

Parameters:

name - The name.

Returns:

The relation or null if this relation doesn't exists!

getVisualisation

public EntityVisualisationModel getVisualisation()

Description copied from interface: EntityModel

Get an object which describes the visualisation of this entity.

Specified by:

getVisualisation in interface EntityModel

Returns:

The visualisation.

setVisualisation

public void setVisualisation(EntityVisualisationModel visualisation)

Specified by:

setVisualisation in interface EntityModel

getSearch

public EntitySearchModel getSearch()

Description copied from interface: EntityModel

Get a description for how to search in this entity.

Specified by:

getSearch in interface EntityModel

Returns:

The search behavior.

addSearch

public void addSearch(EntitySearchModel search)

Description copied from interface: EntityModel

Adds another EntitySearchModel to this EntityModel.

Specified by:

addSearch in interface EntityModel

Parameters:

search - The search model.

removeField

public void removeField(FieldModel toRemove)
                 throws IllegalStateException,
IllegalArgumentException

Specified by:

removeField in interface EntityModel

Parameters:

toRemove - the field to remove

Throws:

IllegalStateException - when try to change the model after finished model-reading

IllegalArgumentException - when the field is not removable (not there)

removeRelation

public void removeRelation(RelationModel toRemove)

Specified by:

removeRelation in interface EntityModel

Parameters:

toRemove - the field to remove

setUseMassMutationActions

public void setUseMassMutationActions(Boolean useMassMutationActions)

Specified by:

setUseMassMutationActions in interface EntityModel

getUseMassMutationActions

public @Nullable Boolean getUseMassMutationActions()

Specified by:

getUseMassMutationActions in interface EntityModel

setUseHistoryAction

public void setUseHistoryAction(Boolean useHistoryAction)

Specified by:

setUseHistoryAction in interface EntityModel

getUseHistoryAction

public @Nullable Boolean getUseHistoryAction()

Specified by:

getUseHistoryAction in interface EntityModel

setUseEntityMergeAction

public void setUseEntityMergeAction(Boolean useEntityMergeAction)

Specified by:

setUseEntityMergeAction in interface EntityModel

getUseEntityMergeAction

public @Nullable Boolean getUseEntityMergeAction()

Specified by:

getUseEntityMergeAction in interface EntityModel

setHasImportAction

public void setHasImportAction(Boolean hasImportAction)

Specified by:

setHasImportAction in interface EntityModel

hasImportAction

public @Nullable Boolean hasImportAction()

Specified by:

hasImportAction in interface EntityModel

setHasExportAction

public void setHasExportAction(Boolean hasExportAction)

Specified by:

setHasExportAction in interface EntityModel

hasExportAction

public @Nullable Boolean hasExportAction()

Specified by:

hasExportAction in interface EntityModel

setUseAdminCreate

public void setUseAdminCreate(Boolean useAdminCreate)

Specified by:

setUseAdminCreate in interface EntityModel

getUseAdminCreate

public Boolean getUseAdminCreate()

Specified by:

getUseAdminCreate in interface EntityModel

setUseAdminDelete

public void setUseAdminDelete(Boolean useAdminDelete)

Specified by:

setUseAdminDelete in interface EntityModel

getUseAdminDelete

public Boolean getUseAdminDelete()

Specified by:

getUseAdminDelete in interface EntityModel

setUseRemoteFieldNewButton

public void setUseRemoteFieldNewButton(Boolean useRemoteFieldNewButton)

Specified by:

setUseRemoteFieldNewButton in interface EntityModel

getUseRemoteFieldNewButton

public Boolean getUseRemoteFieldNewButton()

Specified by:

getUseRemoteFieldNewButton in interface EntityModel

setRelevantForExport

public void setRelevantForExport(Boolean relevantForExport)

Specified by:

setRelevantForExport in interface EntityModel

getRelevantForExport

public Boolean getRelevantForExport()

Specified by:

getRelevantForExport in interface EntityModel

hasGenericActions

public Boolean hasGenericActions()

Specified by:

hasGenericActions in interface EntityModel

setHasGenericActions

public void setHasGenericActions(Boolean hasGenericActions)

Specified by:

setHasGenericActions in interface EntityModel

isMarkable

public Boolean isMarkable()

Specified by:

isMarkable in interface EntityModel

setMarkable

public void setMarkable(Boolean markable)

Specified by:

setMarkable in interface EntityModel

getUseNiceFields

public Boolean getUseNiceFields()

Specified by:

getUseNiceFields in interface EntityModel

setUseNiceFields

public void setUseNiceFields(Boolean useNiceFields)

Specified by:

setUseNiceFields in interface EntityModel

getEntityDocumentsModel

public EntityDocumentsModel getEntityDocumentsModel()

Specified by:

getEntityDocumentsModel in interface EntityModel

setEntityDocumentsModel

public void setEntityDocumentsModel(EntityDocumentsModel entityDocumentsModel)

Specified by:

setEntityDocumentsModel in interface EntityModel

isOutputCenter

public boolean isOutputCenter()

Specified by:

isOutputCenter in interface EntityModel

setOutputCenter

public void setOutputCenter(boolean outputCenter)

Specified by:

setOutputCenter in interface EntityModel

getIndexPriority

public Integer getIndexPriority()

Description copied from interface: EntityModel

Will be used as order for indexing entities. Also describes order when displaying results (higher value is higher in list). Possible values: * -1: not indexed * 0: indexed, but not visible in searching in "full-system-search". used for lookup entities for example. * 1..n: indexed

Specified by:

getIndexPriority in interface EntityModel

setIndexPriority

public void setIndexPriority(Integer indexPriority)

Specified by:

setIndexPriority in interface EntityModel

See Also:

• EntityModel.getIndexPriority()

getBusinessUnitType

public BusinessUnitType getBusinessUnitType()

Specified by:

getBusinessUnitType in interface EntityModel

setBusinessUnitType

public void setBusinessUnitType(BusinessUnitType businessUnitType)

Specified by:

setBusinessUnitType in interface EntityModel

getWidgetEntityType

public WidgetEntityType getWidgetEntityType()

Description copied from interface: EntityModel

Get the entity widget entity type (CMS).

Specified by:

getWidgetEntityType in interface EntityModel

Returns:

the widget entity type.

setWidgetEntityType

public void setWidgetEntityType(WidgetEntityType widgetEntityType)

Description copied from interface: EntityModel

Set widget entity type (CMS).

Specified by:

setWidgetEntityType in interface EntityModel

Parameters:

widgetEntityType - The widget entity type.

hasContentReference

public Boolean hasContentReference()

Description copied from interface: EntityModel

Determine whether this entity can be a content reference source.

Specified by:

hasContentReference in interface EntityModel

Returns:

true, if the entity can be a content reference source, else false.

setContentReference

public void setContentReference(Boolean contentReference)

Description copied from interface: EntityModel

Specify whether this entity can be a content reference source.

Specified by:

setContentReference in interface EntityModel

hasResetInitialvaluesAction

public Boolean hasResetInitialvaluesAction()

Description copied from interface: EntityModel

Determine wheter the reset initialvalues action is shown on this entity or not

Specified by:

hasResetInitialvaluesAction in interface EntityModel

setResetInitialvaluesAction

public void setResetInitialvaluesAction(Boolean resetInitialvaluesAction)

Description copied from interface: EntityModel

Specify whether the reset initialvalues action is shown on this entity or not

Specified by:

setResetInitialvaluesAction in interface EntityModel