Class FieldModelImpl

java.lang.Object

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

ch.tocco.nice2.model.entity.api.DefaultFieldModel

ch.tocco.nice2.model.entity.impl.entity.FieldModelImpl

All Implemented Interfaces:

FieldModel, ModelElement, ModuleTracker

public class FieldModelImpl
extends DefaultFieldModel
implements FieldModel

Constructor Summary

Constructors

Constructor	Description
FieldModelImpl(boolean key)

Method Summary

Modifier and Type	Method	Description
void	addDocumentation(String definingModule, String documentation)	Adds documentation for the FieldModel, contributed by the defining AppModule.
void	addExtendingModule(String moduleName)
Optional<FieldModel>	getBaseField()	Get the base field of a localized field.
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 FieldModel tag as a LinkedHashMap, divided by the AppModules extending the base FieldModel and contributing the documentation.
List<String>	getExtendingModules()	Returns a list of nice2 module names, that have contributed to this model element.
@Nullable DisplayValue	getLabel()
boolean	isBinaryReplacementDisabled()	When a binary field is changed, a dialog is shown to the user to update all other binary fields which contain the same binary data.
boolean	isLocalized()	Tells if this field is multilingual.
boolean	isMandatory()
boolean	isPrivilegedAccessOnly()
boolean	isXssFilter()
void	setBaseField(FieldModel baseField)	Set the base field for synthetic localized fields.
void	setBinaryReplacementDisabled(boolean disabled)
void	setDefiningModule(String name)
void	setLabel(DisplayValue display)
void	setLocalized(boolean flag)
void	setPrivilegedAccessOnly(boolean privilegedAccessOnly)
void	setXssFilter(boolean xssFilter)

Methods inherited from class DefaultFieldModel

getAdditionalToStringInfo, getDefaultValue, getName, getTarget, getType, getValidator, hasNonEmptyValidator, isKey, isNullable, isSynthetic, isUnique, isVirtual, setDefaultValue, setKey, setName, setNullable, setSynthetic, setTarget, setType, setUnique, setValidator, setVirtual

Methods inherited from class DefaultModelBase

toString

Methods inherited from class Object

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

Methods inherited from interface FieldModel

getDefaultValue, getName, getTarget, getType, getValidator, hasNonEmptyValidator, isKey, isNullable, isSynthetic, isUnique, isVirtual, setDefaultValue, setName, setNullable, setSynthetic, setTarget, setType, setUnique, setValidator, setVirtual

Constructor Details

FieldModelImpl

public FieldModelImpl(boolean key)

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: FieldModel

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

Specified by:

getDocumentation in interface FieldModel

Returns:

The LinkedHashMap containg the FieldModel's documentation tag.

addDocumentation

public void addDocumentation(String definingModule,
 String documentation)

Description copied from interface: FieldModel

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

Specified by:

addDocumentation in interface FieldModel

Parameters:

definingModule - the string representation of the AppModule contributing the documentation

documentation - the documentation for the FieldModel

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

getLabel

@Nullable
public @Nullable DisplayValue getLabel()

Specified by:

getLabel in interface FieldModel

Returns:

The label of this field.

setLabel

public void setLabel(DisplayValue display)

Specified by:

setLabel in interface FieldModel

Parameters:

display - the display, non-null

See Also:

• ModelElement

setLocalized

public void setLocalized(boolean flag)

Specified by:

setLocalized in interface FieldModel

Parameters:

flag - true to make it a multilingual field, false to not.

isLocalized

public boolean isLocalized()

Description copied from interface: FieldModel

Tells if this field is multilingual. If it is then this field model most likely has siblings; for every system language there is such a field model for the same field.

Specified by:

isLocalized in interface FieldModel

See Also:

• EntityModel.getFieldByName(String, String)

setXssFilter

public void setXssFilter(boolean xssFilter)

Specified by:

setXssFilter in interface FieldModel

isXssFilter

public boolean isXssFilter()

Specified by:

isXssFilter in interface FieldModel

setBaseField

public void setBaseField(FieldModel baseField)

Description copied from interface: FieldModel

Set the base field for synthetic localized fields.

Specified by:

setBaseField in interface FieldModel

getBaseField

public Optional<FieldModel> getBaseField()

Description copied from interface: FieldModel

Get the base field of a localized field. If the field we're currently working on is localized and FieldModel.getBaseField() doesn't return a field, then it might already be the base field.

Specified by:

getBaseField in interface FieldModel

Returns:

the base field of the localized field.

See Also:

• FieldModel.isLocalized()

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface FieldModel

Returns:

true if a MandatoryValidator is registered for the underlying field and thus the field is mandatory

isBinaryReplacementDisabled

public boolean isBinaryReplacementDisabled()

Description copied from interface: FieldModel

When a binary field is changed, a dialog is shown to the user to update all other binary fields which contain the same binary data. If this boolean flag ist set to `true`, the dialog won't show up if this field is changed. The default value for this flag is `false`.

Specified by:

isBinaryReplacementDisabled in interface FieldModel

setBinaryReplacementDisabled

public void setBinaryReplacementDisabled(boolean disabled)

Specified by:

setBinaryReplacementDisabled in interface FieldModel

isPrivilegedAccessOnly

public boolean isPrivilegedAccessOnly()

Specified by:

isPrivilegedAccessOnly in interface FieldModel

setPrivilegedAccessOnly

public void setPrivilegedAccessOnly(boolean privilegedAccessOnly)

Specified by:

setPrivilegedAccessOnly in interface FieldModel