AttributeModel (Dynamo Framework

All Superinterfaces:

Comparable<AttributeModel>
```
public interface AttributeModel
extends Comparable<AttributeModel>
```
An attribute model represents how a certain attribute of an entity will be behave in the user interface. This includes e.g. whether the attribute is searchable, sortable, what kind of user interface component is used to edit the attribute any many other aspects

Author:

bas.rutten

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCascade(String cascadeTo, String filterPath, CascadeMode mode)` Adds a cascade option
`void`	`addGroupTogetherWith(String path)` Adds a "group together with" attribute.
`Set<String>`	`getAllowedExtensions()`
`AttributeType`	`getAttributeType()`
`Set<String>`	`getCascadeAttributes()`
`String`	`getCascadeFilterPath(String cascadeTo)` Returns the path to filter on when applying a cascade
`CascadeMode`	`getCascadeMode(String cascadeTo)` Returns the cascade mode
`CheckboxMode`	`getCheckboxMode()`
`String`	`getCollectionTableFieldName()`
`String`	`getCollectionTableName()`
`AttributeDateType`	`getDateType()`
`Object`	`getDefaultValue()`
`String`	`getDescription()`
`String`	`getDisplayFormat()`
`String`	`getDisplayName()`
`EditableType`	`getEditableType()`
`EntityModel<?>`	`getEntityModel()`
`float`	`getExpansionFactor()` The expansion factor for sizing components that are rendered on the same row
`String`	`getFalseRepresentation()`
`String`	`getFileNameProperty()`
`List<String>`	`getGroupTogetherWith()`
`Integer`	`getMaxLength()`
`Integer`	`getMaxLengthInTable()` The maximum length of the text representation inside a table
`Long`	`getMaxValue()`
`Class<?>`	`getMemberType()`
`Integer`	`getMinLength()`
`Long`	`getMinValue()`
`String`	`getName()`
`EntityModel<?>`	`getNestedEntityModel()`
`Class<?>`	`getNormalizedType()`
`NumberSelectMode`	`getNumberSelectMode()` Returns the number select mode
`Integer`	`getOrder()`
`String`	`getPath()`
`int`	`getPrecision()`
`String`	`getPrompt()`
`String`	`getQuickAddPropertyName()`
`String`	`getReplacementSearchPath()`
`AttributeSelectMode`	`getSearchSelectMode()`
`AttributeSelectMode`	`getSelectMode()`
`String`	`getStyles()`
`AttributeTextFieldMode`	`getTextFieldMode()`
`String`	`getTrueRepresentation()`
`Class<?>`	`getType()`
`boolean`	`isAlreadyGrouped()`
`boolean`	`isComplexEditable()`
`boolean`	`isCurrency()`
`boolean`	`isDirectNavigation()` Indicates whether this attribute allows direct navigation to entity edit screen
`boolean`	`isEmail()`
`boolean`	`isEmbedded()`
`boolean`	`isImage()`
`boolean`	`isMainAttribute()`
`boolean`	`isMultipleSearch()`
`boolean`	`isNavigable()`
`boolean`	`isNumerical()`
`boolean`	`isPercentage()`
`boolean`	`isQuickAddAllowed()`
`boolean`	`isRequired()`
`boolean`	`isRequiredForSearching()`
`boolean`	`isSearchable()`
`boolean`	`isSearchCaseSensitive()`
`boolean`	`isSearchForExactValue()`
`boolean`	`isSearchPrefixOnly()`
`boolean`	`isSortable()`
`boolean`	`isTransient()`
`boolean`	`isUrl()` Indicates whether this represents a (clickable) URL
`boolean`	`isUseThousandsGrouping()` Indicates whether to use a thousands grouping character
`boolean`	`isVisible()` Indicates whether the attribute is visible
`boolean`	`isVisibleInTable()` Indicates whether the attribute must be shown in a table
`boolean`	`isWeek()` Indicates whether this attribute represents a weekly recurring date
`void`	`removeCascades()` Removes all cascading
`void`	`setMainAttribute(boolean main)` Marks the attribute as the main attribute

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - addCascade
```
void addCascade(String cascadeTo,
                String filterPath,
                CascadeMode mode)
```
    Adds a cascade option
    
    Parameters:
    
    cascadeTo - the path to the attribute to cascade to
    
    filterPath - the path used to filter on
    
    mode - the mode (search, edit, or both)
  - addGroupTogetherWith
```
void addGroupTogetherWith(String path)
```
    Adds a "group together with" attribute. These attributes mentioned as the "group together with" attributes will be rendered on the same line as the attribute for which this model is defined
    
    Parameters:
    
    path - the path to the attribute to group with
  - getAllowedExtensions
```
Set<String> getAllowedExtensions()
```
    Returns:
    
    The allowed extensions for a LOB attribute
  - getAttributeType
```
AttributeType getAttributeType()
```
    Returns:
    
    The attribute type (e.g. BASIC, MASTER, DETAIL) of the attribute
  - getCascadeAttributes
```
Set<String> getCascadeAttributes()
```
    Returns:
    
    the attributes to cascade to when the value of this attribute changes
  - getCascadeFilterPath
```
String getCascadeFilterPath(String cascadeTo)
```
    Returns the path to filter on when applying a cascade
    
    Parameters:
    
    cascadeTo - the path of the property to which to apply cascading
    
    Returns:
    
    the path to filter on
  - getCascadeMode
```
CascadeMode getCascadeMode(String cascadeTo)
```
    Returns the cascade mode
    
    Parameters:
    
    cascadeTo - the path of the property to which to apply cascading
    
    Returns:
    
    when to apply cascading - in search mode, edit mode, or both
  - getCheckboxMode
```
CheckboxMode getCheckboxMode()
```
    Returns:
    
    the desired check box mode (defaults to simply a check box)
  - getCollectionTableFieldName
```
String getCollectionTableFieldName()
```
    Returns:
    
    the name of the field in the collection table that is used to search on when building a token search field for values in a collection table
  - getCollectionTableName
```
String getCollectionTableName()
```
    Returns:
    
    the name of the collection table that is used when building a token search field for values in a collection table
  - getDateType
```
AttributeDateType getDateType()
```
    Returns:
    
    The date type (date, time, or time stamp) of the attribute
  - getDefaultValue
```
Object getDefaultValue()
```
    Returns:
    
    The default value of the attribute
  - getDescription
```
String getDescription()
```
    Returns:
    
    The description of the attribute. This is used as the tool tip in tables
  - getDisplayFormat
```
String getDisplayFormat()
```
    Returns:
    
    The display format of the attribute (used in date formatting)
  - getDisplayName
```
String getDisplayName()
```
    Returns:
    
    The display name of the attribute
  - getEditableType
```
EditableType getEditableType()
```
    Returns:
    
    When the attribute can be edited
  - getEntityModel
```
EntityModel<?> getEntityModel()
```
    Returns:
    
    The EntityModel for the entity that contains this attribute
  - getExpansionFactor
```
float getExpansionFactor()
```
    The expansion factor for sizing components that are rendered on the same row
    
    Returns:
  - getFalseRepresentation
```
String getFalseRepresentation()
```
    Returns:
    
    The textual representation of a "false" value
  - getFileNameProperty
```
String getFileNameProperty()
```
    Returns:
    
    The name of the property in which to store the file name of an uploaded file
  - getGroupTogetherWith
```
List<String> getGroupTogetherWith()
```
    Returns:
    
    the paths to the other attributes that must be appear on the same line in an edit form
  - getMaxLength
```
Integer getMaxLength()
```
    Returns:
    
    The maximum allowed length of the attribute (inside a collection table)
  - getMaxLengthInTable
```
Integer getMaxLengthInTable()
```
    The maximum length of the text representation inside a table
    
    Returns:
  - getMaxValue
```
Long getMaxValue()
```
    Returns:
    
    the maximum allowed value of the attribute (inside a collection table)
  - getMemberType
```
Class<?> getMemberType()
```
    Returns:
    
    the member type of the collection, if this attribute holds a collection of values
  - getMinLength
```
Integer getMinLength()
```
    Returns:
    
    the minimum allowed length of the attribute (inside a collection table)
  - getMinValue
```
Long getMinValue()
```
    Returns:
    
    the minimum allowed value of the attribute (inside a collection table)
  - getName
```
String getName()
```
    Returns:
    
    The name/identifier of the attribute
  - getNestedEntityModel
```
EntityModel<?> getNestedEntityModel()
```
    Returns:
    
    The nested entity model for this attribute
  - getNormalizedType
```
Class<?> getNormalizedType()
```
    Returns:
    
    The normalized type of the attribute (this is the same as the type in case of a singular attribute, and the member type of the collection case of collection attribute
  - getNumberSelectMode
```
NumberSelectMode getNumberSelectMode()
```
    Returns the number select mode
    
    Returns:
    
    the number select mode (can be used to switch between text field and slider)
  - getOrder
```
Integer getOrder()
```
    Returns:
    
    The order number (used to internally order the attribute models)
  - getPath
```
String getPath()
```
    Returns:
    
    The (nested) path to this attribute
  - getPrecision
```
int getPrecision()
```
    Returns:
    
    The precision (number of decimals) to use when displaying a decimal number
  - getPrompt
```
String getPrompt()
```
    Returns:
    
    The value to display as the input prompt value inside an edit field
  - getQuickAddPropertyName
```
String getQuickAddPropertyName()
```
    Returns:
    
    the name of the property to which to assign a value in case of a "quick addition"
  - getReplacementSearchPath
```
String getReplacementSearchPath()
```
    Returns:
    
    The path by which to replace the actual path when carrying out a search. This is needed in very specific cases when an Entity has multiple detail relations that are mapped to the same table
  - getSearchSelectMode
```
AttributeSelectMode getSearchSelectMode()
```
    Returns:
    
    The search select mode (determines which component to render in search screens)
  - getSelectMode
```
AttributeSelectMode getSelectMode()
```
    Returns:
    
    The select mode (determines which component to render in edit screens)
  - getStyles
```
String getStyles()
```
    Returns:
    
    the styles to apply for this component
  - getTextFieldMode
```
AttributeTextFieldMode getTextFieldMode()
```
    Returns:
    
    The text field mode (text fiel or text area)
  - getTrueRepresentation
```
String getTrueRepresentation()
```
    Returns:
    
    The textual representation of a "true" value
  - getType
```
Class<?> getType()
```
    Returns:
    
    The Java type of the property
  - isAlreadyGrouped
```
boolean isAlreadyGrouped()
```
    Returns:
    
    true if the attribute is already included in a "groupTogetherWith" clause
  - isComplexEditable
```
boolean isComplexEditable()
```
    Returns:
    
    Whether the property is present inside an edit form. By default this is switched off for complex (i.e. MASTER or DETAIL) objects
  - isCurrency
```
boolean isCurrency()
```
    Returns:
    
    Whether this property represents a currency
  - isDirectNavigation
```
boolean isDirectNavigation()
```
    Indicates whether this attribute allows direct navigation to entity edit screen
  - isEmail
```
boolean isEmail()
```
    Returns:
    
    Whether the attribute is an email address
  - isEmbedded
```
boolean isEmbedded()
```
    Returns:
    
    Whether this is an embedded attribute
  - isImage
```
boolean isImage()
```
    Returns:
    
    Whether this attribute represents an image
  - isMainAttribute
```
boolean isMainAttribute()
```
    Returns:
    
    Whether this is the "main" attribute
  - isMultipleSearch
```
boolean isMultipleSearch()
```
    Returns:
    
    Whether "multiple search" is supported for this attribute
  - isNavigable
```
boolean isNavigable()
```
    Returns:
  - isNumerical
```
boolean isNumerical()
```
    Returns:
    
    Whether this is a numeric attribute
  - isPercentage
```
boolean isPercentage()
```
    Returns:
    
    Whether the attribute represents a percentage
  - isQuickAddAllowed
```
boolean isQuickAddAllowed()
```
  - isRequired
```
boolean isRequired()
```
    Returns:
    
    whether the attribute is a required attribute (entity can only be saved if values for all required attributes have been provided)
  - isRequiredForSearching
```
boolean isRequiredForSearching()
```
    Returns:
    
    whether it is required to fill in a value for this attribute before you can carry out a search
  - isSearchable
```
boolean isSearchable()
```
    Returns:
    
    whether it is possible to search on this attribute
  - isSearchCaseSensitive
```
boolean isSearchCaseSensitive()
```
    Returns:
    
    whether searching on this attribute is case sensitive (only applies if this is a String attribute)
  - isSearchForExactValue
```
boolean isSearchForExactValue()
```
    Returns:
    
    whether searching for this value is by exact match (rather than using a range). Only applicable to numerical and date field
  - isSearchPrefixOnly
```
boolean isSearchPrefixOnly()
```
    Returns:
    
    whether searching should only match on prefixes rather than on a substring occurring anywhere
  - isSortable
```
boolean isSortable()
```
    Returns:
    
    whether the attribute is sortable
  - isTransient
```
boolean isTransient()
```
    Returns:
    
    whether the attribute is transient
  - isUrl
```
boolean isUrl()
```
    Indicates whether this represents a (clickable) URL
    
    Returns:
  - isUseThousandsGrouping
```
boolean isUseThousandsGrouping()
```
    Indicates whether to use a thousands grouping character
    
    Returns:
  - isVisible
```
boolean isVisible()
```
    Indicates whether the attribute is visible
    
    Returns:
  - isVisibleInTable
```
boolean isVisibleInTable()
```
    Indicates whether the attribute must be shown in a table
    
    Returns:
  - isWeek
```
boolean isWeek()
```
    Indicates whether this attribute represents a weekly recurring date
    
    Returns:
  - removeCascades
```
void removeCascades()
```
    Removes all cascading
  - setMainAttribute
```
void setMainAttribute(boolean main)
```
    Marks the attribute as the main attribute
    
    Parameters:
    
    main - whether the attribute is the main attribute

Interface AttributeModel

Method Summary

Methods inherited from interface java.lang.Comparable

Method Detail

addCascade

addGroupTogetherWith

getAllowedExtensions

getAttributeType

getCascadeAttributes

getCascadeFilterPath

getCascadeMode

getCheckboxMode

getCollectionTableFieldName

getCollectionTableName

getDateType

getDefaultValue

getDescription

getDisplayFormat

getDisplayName

getEditableType

getEntityModel

getExpansionFactor

getFalseRepresentation

getFileNameProperty

getGroupTogetherWith

getMaxLength

getMaxLengthInTable

getMaxValue

getMemberType

getMinLength

getMinValue

getName

getNestedEntityModel

getNormalizedType

getNumberSelectMode

getOrder

getPath

getPrecision

getPrompt

getQuickAddPropertyName

getReplacementSearchPath

getSearchSelectMode

getSelectMode

getStyles

getTextFieldMode

getTrueRepresentation

getType

isAlreadyGrouped

isComplexEditable

isCurrency

isDirectNavigation

isEmail

isEmbedded

isImage

isMainAttribute

isMultipleSearch

isNavigable

isNumerical

isPercentage

isQuickAddAllowed

isRequired

isRequiredForSearching

isSearchable

isSearchCaseSensitive

isSearchForExactValue

isSearchPrefixOnly

isSortable

isTransient

isUrl

isUseThousandsGrouping

isVisible

isVisibleInTable

isWeek

removeCascades

setMainAttribute