Package ch.tocco.nice2.model.entity.api.relations

Class RelationModelImpl

java.lang.Object

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

ch.tocco.nice2.model.entity.api.DefaultRelationModel

ch.tocco.nice2.model.entity.api.relations.RelationModelImpl

All Implemented Interfaces:

ModelElement, ModuleTracker, RelationModel

public class RelationModelImpl
extends DefaultRelationModel
implements RelationModel

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.model.entity.api.RelationModel

RelationModel.DefaultComponentConfig

Constructor Summary

Constructors

Constructor	Description
RelationModelImpl()

Method Summary

Modifier and Type	Method	Description
void	addDocumentation(String definingModule, String documentation)	Adds documentation for the RelationModel, contributed by the defining AppModule.
void	addExtendingModule(String moduleName)
Optional<RelationModel.DefaultComponentConfig>	getDefaultComponentConfig()
DefaultValueDescriptor	getDefaultValue()
String	getDefiningModule()	Returns the name of the nice2 module, where this model element is defined.
DeleteBehavior	getDeleteBehavior()
int	getDisplayOrder()	Returns the number of display priority.
LinkedHashMap<String,String>	getDocumentation()	Returns the content of the documentation element of the RelationModel tag as a LinkedHashMap, divided by the AppModules extending the base RelationModel and contributing the documentation.
List<String>	getExtendingModules()	Returns a list of nice2 module names, that have contributed to this model element.
DisplayValue	getLabel()	The label of this relation
RelationModel	getReverse()	Get the reverse-relation.
EntityModel	getSourceEntity()	The source-entity.
EntityModel	getTargetEntity()	The source-entity.
boolean	isPropagatingLock()	If the RelationModel.getSourceEntity() is locked, does this lock propagate over the relation to all target-entities?
boolean	isSystemRelation()
void	setAsSystemRelation(boolean systemRelation)	mark the relation as generated by the system system relation are ignored in GenerateMissingFormModelProvider
void	setDefaultComponentConfig(RelationModel.DefaultComponentConfig componentConfig)	set the default component config for this relation
void	setDefaultValue(DefaultValueDescriptor value)
void	setDefiningModule(String name)
void	setDeleteBehavior(DeleteBehavior deleteBehavior)
void	setDisplayOrder(int displayOrder)
void	setLabel(DisplayValue label)
void	setPropagatingLock(boolean isPropagatingLock)
void	setReverseRelation(RelationModel reverse)
void	setSourceEntity(EntityModel sourceType)
void	setTargetEntity(EntityModel targetType)

Methods inherited from class ch.tocco.nice2.model.entity.api.DefaultRelationModel

getAdditionalToStringInfo, getLink, getName, getSelector, getSelectors, getValidator, hasNonEmptyValidator, isReverse, isTargetAggregate, isTargetRequired, isToMany, putSelector, setLink, setMany, setName, setRequired, setReverse, setTargetAggregate, setValidator

Methods inherited from class ch.tocco.nice2.model.entity.api.DefaultModelBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.model.entity.api.RelationModel

getLink, getName, getSelector, getSelectors, getValidator, hasNonEmptyValidator, isReverse, isTargetRequired, isToMany, putSelector, setLink, setMany, setName, setRequired, setReverse, setValidator

Constructor Details

RelationModelImpl

public RelationModelImpl()

Method Details

getLabel

public DisplayValue getLabel()

Description copied from interface: RelationModel

The label of this relation

Specified by:

getLabel in interface RelationModel

Returns:

.

setLabel

public void setLabel(DisplayValue label)

Specified by:

setLabel in interface RelationModel

Parameters:

label - the label, non-null

getDocumentation

public LinkedHashMap<String,String> getDocumentation()

Description copied from interface: RelationModel

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

Specified by:

getDocumentation in interface RelationModel

Returns:

The LinkedHashMap containg the RelationModel's documentation tag.

addDocumentation

public void addDocumentation(String definingModule,
 String documentation)

Description copied from interface: RelationModel

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

Specified by:

addDocumentation in interface RelationModel

Parameters:

definingModule - the string representation of the AppModule contributing the documentation

documentation - the documentation for the RelationModel

setReverseRelation

public void setReverseRelation(RelationModel reverse)

Specified by:

setReverseRelation in interface RelationModel

Overrides:

setReverseRelation in class DefaultRelationModel

Parameters:

reverse - the the reverse relation.

See Also:

• ModelElement

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

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

setPropagatingLock

public void setPropagatingLock(boolean isPropagatingLock)

Specified by:

setPropagatingLock in interface RelationModel

Parameters:

isPropagatingLock - do the related entitis get locked, if the source-entity is locked?

getSourceEntity

public EntityModel getSourceEntity()

Description copied from interface: RelationModel

The source-entity.

Example: relation from 'Address' to 'Event' it's the 'Address'.

Specified by:

getSourceEntity in interface RelationModel

Overrides:

getSourceEntity in class DefaultRelationModel

getTargetEntity

public EntityModel getTargetEntity()

Description copied from interface: RelationModel

The source-entity.

Example: relation from 'Address' to 'Event' it's the 'Event'.

Specified by:

getTargetEntity in interface RelationModel

Overrides:

getTargetEntity in class DefaultRelationModel

getDeleteBehavior

public DeleteBehavior getDeleteBehavior()

Specified by:

getDeleteBehavior in interface RelationModel

Returns:

Returns a description how entities behave when they are deleted.

getDisplayOrder

public int getDisplayOrder()

Description copied from interface: RelationModel

Returns the number of display priority. The lower the higher ;-)

Specified by:

getDisplayOrder in interface RelationModel

Returns:

-1 means don't display, 0 means no config set (fall back to defaults), >=1 otherwise.

setDisplayOrder

public void setDisplayOrder(int displayOrder)

Specified by:

setDisplayOrder in interface RelationModel

setSourceEntity

public void setSourceEntity(EntityModel sourceType)

Specified by:

setSourceEntity in interface RelationModel

Overrides:

setSourceEntity in class DefaultRelationModel

Parameters:

sourceType - the source-entity, non-null

See Also:

• ModelElement

setTargetEntity

public void setTargetEntity(EntityModel targetType)

Specified by:

setTargetEntity in interface RelationModel

Overrides:

setTargetEntity in class DefaultRelationModel

Parameters:

targetType - the target-entity, non-null

See Also:

• ModelElement

getReverse

public RelationModel getReverse()

Description copied from interface: RelationModel

Get the reverse-relation.

For example the relation is 'Address' to 'Event' called 'relSubscribedTo'. This getter will the return the reverse-relation, 'Event' to 'Address' called 'relSubcribers'

So in the end, the call "relation.getReverse().getReverse()" will return 'relation'. Its circular referncing.

Specified by:

getReverse in interface RelationModel

Overrides:

getReverse in class DefaultRelationModel

isPropagatingLock

public boolean isPropagatingLock()

Description copied from interface: RelationModel

If the RelationModel.getSourceEntity() is locked, does this lock propagate over the relation to all target-entities?

Specified by:

isPropagatingLock in interface RelationModel

Returns:

.

setDeleteBehavior

public void setDeleteBehavior(DeleteBehavior deleteBehavior)

Specified by:

setDeleteBehavior in interface RelationModel

Parameters:

deleteBehavior - set the deletion-behavior, non-null

setDefaultValue

public void setDefaultValue(DefaultValueDescriptor value)

Specified by:

setDefaultValue in interface RelationModel

getDefaultValue

public DefaultValueDescriptor getDefaultValue()

Specified by:

getDefaultValue in interface RelationModel

isSystemRelation

public boolean isSystemRelation()

Specified by:

isSystemRelation in interface RelationModel

Returns:

true if the relation is marked as generated by the system

setAsSystemRelation

public void setAsSystemRelation(boolean systemRelation)

Description copied from interface: RelationModel

mark the relation as generated by the system system relation are ignored in GenerateMissingFormModelProvider

Specified by:

setAsSystemRelation in interface RelationModel

setDefaultComponentConfig

public void setDefaultComponentConfig(RelationModel.DefaultComponentConfig componentConfig)

Description copied from interface: RelationModel

set the default component config for this relation

Specified by:

setDefaultComponentConfig in interface RelationModel

getDefaultComponentConfig

public Optional<RelationModel.DefaultComponentConfig> getDefaultComponentConfig()

Specified by:

getDefaultComponentConfig in interface RelationModel