Attribute (Celerio API)

java.lang.Object
- com.jaxio.celerio.support.AbstractNamer
- - com.jaxio.celerio.model.Attribute

All Implemented Interfaces:

Namer, Named, Map<String,Object>
```
public class Attribute
extends AbstractNamer
implements Named, Map<String,Object>
```
JPA Attribute meta information.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static`	`IS_EMAIL`
`static`	`IS_FILE_BINARY`
`static`	`IS_FILE_CONTENT_TYPE`
`static`	`IS_FILE_NAME`
`static`	`IS_FILE_SIZE`
`static`	`IS_PASSWORD`

Constructor Summary

Constructors
Constructor and Description

Attribute()

Constructors
Constructor and Description
`Attribute()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`columnNameHasLanguageSuffix()`
`boolean`	`containsKey(Object arg0)`
`boolean`	`containsValue(Object arg0)`
`Set<Map.Entry<String,Object>>`	`entrySet()`
`boolean`	`equals(Object o)`
`Object`	`get(Object arg0)`
`Boolean`	`getAutoIncrement()` Null means, we do not know... happens for example when the driver does not support the IS_AUTOINCREMENT feature.
`String`	`getCachedVar()`
`com.jaxio.celerio.factory.RelationCollisionUtil`	`getCollisionUtil()`
`ColumnConfig`	`getColumnConfig()`
`String`	`getColumnFullName()`
`String`	`getColumnName()`
`String`	`getColumnNameEscaped()`
`String`	`getColumnNameLanguage()`
`String`	`getColumnNameWithoutLanguage()`
`String`	`getComment()`
`Config`	`getConfig()`
`String`	`getDefaultValueForCurrentAccountId()`
`String`	`getDisplayOrderAsString()` Used to sort columns in abstract list holder.
`Entity`	`getEntity()`
`Entity`	`getEntityIPointTo()`
`String`	`getEnumClass()`
`EnumConfig`	`getEnumConfig()`
`String`	`getEnumItemsType()`
`String`	`getEnumItemsVar()`
`EnumNamer`	`getEnumModel()`
`EnumType`	`getEnumType()`
`Attribute`	`getFile()`
`Attribute`	`getFileContentType()`
`Attribute`	`getFilename()`
`Attribute`	`getFileSize()`
`String`	`getFullColumnName()`
`String`	`getFullModelVar()`
`String`	`getFullName()`
`String`	`getFullType()` The full Java type, with package information.
`String`	`getFullTypeIfImportNeeded()` Since import is always complicated, I use full type when needed for now in XxxValidator...
`String`	`getFullVar()`
`com.jaxio.celerio.aspects.ForbiddenWhenBuildingAspect`	`getFwba()`
`Boolean`	`getIsContentType()`
`Boolean`	`getIsEmail()`
`Boolean`	`getIsFile()`
`Boolean`	`getIsFilename()`
`Boolean`	`getIsFileSize()`
`Boolean`	`getIsInFileDefinition()`
`Boolean`	`getIsPassword()`
`String`	`getJavaDefaultValue()`
`String`	`getJavadoc()`
`JdbcType`	`getJdbcType()`
`JpaAttribute`	`getJpa()`
`String`	`getLabelName()`
`Labels`	`getLabels()`
`MappedType`	`getMappedType()`
`String`	`getName()`
`String`	`getOneLineComment()` When there are dozen of attributes, it is convenient to have next to the attribute declaration a short comment such as "// not null"
`String`	`getPackageName()` The full package name.
`String`	`getSetterAccessibility()`
`int`	`getSize()`
`Map<String,Object>`	`getSpis()`
`String`	`getTableName()`
`String`	`getType()` The java Type name, without any package information.
`String`	`getValidate()`
`String`	`getVar()` The var for the current type.
`String`	`getVarPath()`
`Relation`	`getXToOneRelation()`
`boolean`	`hasComment()`
`boolean`	`hasDefaultValue()`
`boolean`	`hasDigits()` Whether this attribute is numeric and is neither an enum nor a version.
`boolean`	`hasForwardXToOneRelation()` Should replace hasXToOneRelation.
`int`	`hashCode()`
`boolean`	`hasIntSetter()`
`boolean`	`hasPertinentDefaultValue()`
`boolean`	`hasXToOneRelation()`
`boolean`	`isAuditEntityAttribute()`
`boolean`	`isBigDecimal()`
`boolean`	`isBigInteger()`
`boolean`	`isBinary()` Is the corresponding column a LOB, BLOB or CLOB.
`boolean`	`isBlob()`
`boolean`	`isBoolean()`
`boolean`	`isChar()`
`boolean`	`isCharPadding()`
`boolean`	`isClob()`
`boolean`	`isComparable()`
`boolean`	`isContentType()`
`boolean`	`isCpkPatternSearchable()`
`boolean`	`isDate()`
`boolean`	`isDouble()`
`boolean`	`isEmail()`
`boolean`	`isEmpty()`
`boolean`	`isEnum()`
`boolean`	`isFile()`
`boolean`	`isFileBinary()`
`boolean`	`isFilename()`
`boolean`	`isFileSize()`
`boolean`	`isFixedSize()`
`boolean`	`isFloat()`
`boolean`	`isFormField()`
`boolean`	`isHidden()`
`boolean`	`isHtml()`
`boolean`	`isInBk()`
`boolean`	`isInCompositeFk()`
`boolean`	`isInCpk()`
`boolean`	`isIndexed()` Whether this attribute has a non null `IndexedField` configuration element.
`boolean`	`isInFileDefinition()`
`boolean`	`isInFk()`
`boolean`	`isInPk()`
`boolean`	`isInteger()`
`boolean`	`isIntegralNumber()` Whether this attribute is an integer, a long or a big integer.
`boolean`	`isJavaBaseClass()`
`boolean`	`isJavaUtilDate()`
`boolean`	`isJavaUtilDateAndTime()`
`boolean`	`isJavaUtilOnlyDate()`
`boolean`	`isJavaUtilOnlyTime()`
`boolean`	`isJodaLocalDate()`
`boolean`	`isJodaLocalDateTime()`
`boolean`	`isJodaTime()`
`boolean`	`isLabel()`
`boolean`	`isLazyLoaded()`
`boolean`	`isLob()`
`boolean`	`isLocaleKey()`
`boolean`	`isLocalizable()`
`boolean`	`isLong()`
`boolean`	`isMultiSelectable()` Can we apply a search with a PropertySelector on this attribute?
`boolean`	`isNotNullable()`
`boolean`	`isNullable()`
`boolean`	`isNumeric()`
`boolean`	`isPassword()`
`boolean`	`isPatternSearchable()`
`boolean`	`isRangeable()` Can we apply a search by range with this attribute?
`boolean`	`isRequired()`
`boolean`	`isSafeHtml()`
`boolean`	`isSearchField()`
`boolean`	`isSearchResultField()`
`boolean`	`isSearchResultFieldConvention()`
`boolean`	`isSetterAccessibilityPublic()`
`boolean`	`isSimple()`
`boolean`	`isSimpleFk()`
`boolean`	`isSimplePk()`
`boolean`	`isSortable()`
`boolean`	`isString()`
`boolean`	`isTextArea()`
`boolean`	`isTransient()`
`boolean`	`isUnique()`
`boolean`	`isUrl()`
`boolean`	`isVersion()`
`boolean`	`isVisible()`
`boolean`	`isXToOneRelationSet()`
`Set<String>`	`keySet()`
`Object`	`put(String arg0, Object arg1)`
`void`	`putAll(Map<? extends String,? extends Object> arg0)`
`Object`	`remove(Object arg0)`
`void`	`setColumnConfig(ColumnConfig columnConfig)`
`void`	`setEntity(Entity entity)`
`void`	`setInBk(boolean inBk)`
`void`	`setInCompositeFk(boolean inCompositeFk)`
`void`	`setInCpk(boolean inCpk)`
`void`	`setSimpleFk(boolean simpleFk)`
`void`	`setSimplePk(boolean simplePk)`
`int`	`size()`
`String`	`toString()`
`Collection<Object>`	`values()`

Methods inherited from class com.jaxio.celerio.support.AbstractNamer
getAdder, getAdders, getContains, getEditer, getGetter, getGetterLocalized, getGetters, getHas, getHasPlural, getHibernateFilterName, getPackageNode, getPackageNodeUp, getPath, getRandomGetter, getRemover, getRemovers, getSetter, getSetters, getTestType, getTypeLow, getUniqueDeleter, getUniqueGetter, getVarLocalized, getVars, getVarsUp, getVarUp, getWith

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Field Detail

IS_FILE_SIZE
```
public static  IS_FILE_SIZE
```

IS_FILE_NAME
```
public static  IS_FILE_NAME
```

IS_FILE_BINARY
```
public static  IS_FILE_BINARY
```

IS_FILE_CONTENT_TYPE
```
public static  IS_FILE_CONTENT_TYPE
```

IS_EMAIL
```
public static  IS_EMAIL
```

IS_PASSWORD
```
public static  IS_PASSWORD
```

Constructor Detail
- Attribute
```
public Attribute()
```

Method Detail

setEntity
```
public void setEntity(Entity entity)
```

setColumnConfig

public void setColumnConfig(ColumnConfig columnConfig)

getVar
```
public String getVar()
```
Description copied from interface: Namer

The var for the current type. Starts with a lower case. Ex: parentBankAccount.

Specified by:

getVar in interface Namer

Overrides:

getVar in class AbstractNamer

getEnumType
```
public EnumType getEnumType()
```

getFullName
```
public String getFullName()
```

getFullVar
```
public String getFullVar()
```

getFullModelVar
```
public String getFullModelVar()
```

getFullColumnName
```
public String getFullColumnName()
```

getValidate
```
public String getValidate()
```

getLabelName
```
public String getLabelName()
```

getLabels
```
public Labels getLabels()
```

getAutoIncrement
```
public Boolean getAutoIncrement()
```
Null means, we do not know... happens for example when the driver does not support the IS_AUTOINCREMENT feature.

isSimplePk
```
public boolean isSimplePk()
```

setInCpk
```
public void setInCpk(boolean inCpk)
```

isInCpk
```
public boolean isInCpk()
```

setSimpleFk

public void setSimpleFk(boolean simpleFk)

isSimpleFk
```
public boolean isSimpleFk()
```

setInCompositeFk

public void setInCompositeFk(boolean inCompositeFk)

isInCompositeFk
```
public boolean isInCompositeFk()
```

isSimple
```
public boolean isSimple()
```

getSetterAccessibility

public String getSetterAccessibility()

isSetterAccessibilityPublic

public boolean isSetterAccessibilityPublic()

getName
```
public String getName()
```
Specified by:

getName in interface Named

getColumnName
```
public String getColumnName()
```

getColumnNameEscaped
```
public String getColumnNameEscaped()
```

getColumnFullName
```
public String getColumnFullName()
```

getTableName
```
public String getTableName()
```

getJdbcType
```
public JdbcType getJdbcType()
```

isJavaBaseClass
```
public boolean isJavaBaseClass()
```

isEnum
```
public boolean isEnum()
```

isSortable
```
public boolean isSortable()
```

getEnumConfig
```
public EnumConfig getEnumConfig()
```

getEnumModel
```
public EnumNamer getEnumModel()
```

getEnumClass
```
public String getEnumClass()
```

getEnumItemsType
```
public String getEnumItemsType()
```

getEnumItemsVar
```
public String getEnumItemsVar()
```

getSize
```
public int getSize()
```

isFixedSize
```
public boolean isFixedSize()
```

getComment
```
public String getComment()
```

getJavadoc
```
public String getJavadoc()
```

hasComment
```
public boolean hasComment()
```

isUnique
```
public boolean isUnique()
```

isRequired
```
public boolean isRequired()
```

isCharPadding
```
public boolean isCharPadding()
```

isNullable
```
public boolean isNullable()
```

isNotNullable
```
public boolean isNotNullable()
```

hasDefaultValue
```
public boolean hasDefaultValue()
```

hasPertinentDefaultValue

public boolean hasPertinentDefaultValue()

getJavaDefaultValue
```
public String getJavaDefaultValue()
```

getDisplayOrderAsString
```
public String getDisplayOrderAsString()
```
Used to sort columns in abstract list holder. Must be a String.

getType
```
public String getType()
```
Description copied from interface: Namer

The java Type name, without any package information. Ex: BankAccount.

Specified by:

getType in interface Namer

Specified by:

getType in class AbstractNamer

getFullType
```
public String getFullType()
```
Description copied from interface: Namer

The full Java type, with package information. Ex: com.company.project.domain.BankAccount.

Specified by:

getFullType in interface Namer

Overrides:

getFullType in class AbstractNamer

getFullTypeIfImportNeeded
```
public String getFullTypeIfImportNeeded()
```
Since import is always complicated, I use full type when needed for now in XxxValidator...

isLocaleKey
```
public boolean isLocaleKey()
```

columnNameHasLanguageSuffix

public boolean columnNameHasLanguageSuffix()

isLabel
```
public boolean isLabel()
```

getColumnNameWithoutLanguage

public String getColumnNameWithoutLanguage()

getColumnNameLanguage
```
public String getColumnNameLanguage()
```

isVersion
```
public boolean isVersion()
```

isInFileDefinition
```
public boolean isInFileDefinition()
```

isFile
```
public boolean isFile()
```

isFileBinary
```
public boolean isFileBinary()
```

isFileSize
```
public boolean isFileSize()
```

isFilename
```
public boolean isFilename()
```

isContentType
```
public boolean isContentType()
```

isPatternSearchable
```
public boolean isPatternSearchable()
```

isCpkPatternSearchable

public boolean isCpkPatternSearchable()

isTransient
```
public boolean isTransient()
```

getFileSize
```
public Attribute getFileSize()
```

getFileContentType
```
public Attribute getFileContentType()
```

getFilename
```
public Attribute getFilename()
```

getFile
```
public Attribute getFile()
```

isEmail
```
public boolean isEmail()
```

isPassword
```
public boolean isPassword()
```

isVisible
```
public boolean isVisible()
```

isFormField
```
public boolean isFormField()
```

isSearchResultFieldConvention

public boolean isSearchResultFieldConvention()

isSearchResultField
```
public boolean isSearchResultField()
```

isSearchField
```
public boolean isSearchField()
```

isRangeable
```
public boolean isRangeable()
```
Can we apply a search by range with this attribute?

isMultiSelectable
```
public boolean isMultiSelectable()
```
Can we apply a search with a PropertySelector on this attribute?

getMappedType
```
public MappedType getMappedType()
```

getPackageName
```
public final String getPackageName()
```
Description copied from interface: Namer

The full package name. Ex: com.company

Specified by:

getPackageName in interface Namer

Specified by:

getPackageName in class AbstractNamer

hasDigits
```
public final boolean hasDigits()
```
Whether this attribute is numeric and is neither an enum nor a version.

Returns:

isNumeric
```
public final boolean isNumeric()
```

isLong
```
public final boolean isLong()
```

isInteger
```
public final boolean isInteger()
```

isBigInteger
```
public final boolean isBigInteger()
```

isDouble
```
public final boolean isDouble()
```

isFloat
```
public final boolean isFloat()
```

isBigDecimal
```
public final boolean isBigDecimal()
```

isString
```
public final boolean isString()
```

isChar
```
public final boolean isChar()
```

isBoolean
```
public final boolean isBoolean()
```

isDate
```
public final boolean isDate()
```

isJavaUtilDate
```
public final boolean isJavaUtilDate()
```

isJavaUtilOnlyDate

public final boolean isJavaUtilOnlyDate()

isJavaUtilDateAndTime

public final boolean isJavaUtilDateAndTime()

isJavaUtilOnlyTime

public final boolean isJavaUtilOnlyTime()

isJodaTime
```
public final boolean isJodaTime()
```

isJodaLocalDate

public final boolean isJodaLocalDate()

isJodaLocalDateTime

public final boolean isJodaLocalDateTime()

isLob
```
public final boolean isLob()
```

isBlob
```
public final boolean isBlob()
```

isClob
```
public final boolean isClob()
```

isComparable
```
public final boolean isComparable()
```

isIntegralNumber
```
public final boolean isIntegralNumber()
```
Whether this attribute is an integer, a long or a big integer.

isBinary
```
public final boolean isBinary()
```
Is the corresponding column a LOB, BLOB or CLOB.

Returns:

isIndexed
```
public boolean isIndexed()
```
Whether this attribute has a non null IndexedField configuration element.

See Also:
ColumnConfig.getIndexedField();

isInPk
```
public boolean isInPk()
```

isInFk
```
public boolean isInFk()
```

isHidden
```
public boolean isHidden()
```

isLazyLoaded
```
public boolean isLazyLoaded()
```

isLocalizable
```
public boolean isLocalizable()
```

hasIntSetter
```
public boolean hasIntSetter()
```

isHtml
```
public boolean isHtml()
```

isSafeHtml
```
public boolean isSafeHtml()
```

isUrl
```
public boolean isUrl()
```

isTextArea
```
public boolean isTextArea()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

isAuditEntityAttribute

public boolean isAuditEntityAttribute()

equals
```
public final boolean equals(Object o)
```
Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class Object

hashCode
```
public final int hashCode()
```
Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class Object

getDefaultValueForCurrentAccountId

public String getDefaultValueForCurrentAccountId()

getOneLineComment
```
public String getOneLineComment()
```
When there are dozen of attributes, it is convenient to have next to the attribute declaration a short comment such as "// not null"

hasXToOneRelation
```
public boolean hasXToOneRelation()
```

hasForwardXToOneRelation
```
public boolean hasForwardXToOneRelation()
```
Should replace hasXToOneRelation.

getXToOneRelation
```
public Relation getXToOneRelation()
```

getEntityIPointTo
```
public Entity getEntityIPointTo()
```

getVarPath
```
public String getVarPath()
```

clear
```
public void clear()
```
Specified by:

clear in interface Map<String,Object>

containsKey
```
public boolean containsKey(Object arg0)
```
Specified by:

containsKey in interface Map<String,Object>

containsValue
```
public boolean containsValue(Object arg0)
```
Specified by:

containsValue in interface Map<String,Object>

entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
Specified by:

entrySet in interface Map<String,Object>

get
```
public Object get(Object arg0)
```
Specified by:

get in interface Map<String,Object>

isEmpty
```
public boolean isEmpty()
```
Specified by:

isEmpty in interface Map<String,Object>

keySet
```
public Set<String> keySet()
```
Specified by:

keySet in interface Map<String,Object>

put

public Object put(String arg0,
         Object arg1)

Specified by:: put in interface Map<String,Object>

putAll

public void putAll(Map<? extends String,? extends Object> arg0)

Specified by:: putAll in interface Map<String,Object>

remove
```
public Object remove(Object arg0)
```
Specified by:

remove in interface Map<String,Object>

size
```
public int size()
```
Specified by:

size in interface Map<String,Object>

values
```
public Collection<Object> values()
```
Specified by:

values in interface Map<String,Object>

getConfig
```
public Config getConfig()
```

getCollisionUtil

public com.jaxio.celerio.factory.RelationCollisionUtil getCollisionUtil()

getEntity
```
public Entity getEntity()
```

getColumnConfig
```
public ColumnConfig getColumnConfig()
```

getJpa
```
public JpaAttribute getJpa()
```

getFwba

public com.jaxio.celerio.aspects.ForbiddenWhenBuildingAspect getFwba()

getCachedVar
```
public String getCachedVar()
```

getIsInFileDefinition

public Boolean getIsInFileDefinition()

getIsFile
```
public Boolean getIsFile()
```

getIsFileSize
```
public Boolean getIsFileSize()
```

getIsFilename
```
public Boolean getIsFilename()
```

getIsContentType
```
public Boolean getIsContentType()
```

getIsEmail
```
public Boolean getIsEmail()
```

getIsPassword
```
public Boolean getIsPassword()
```

isXToOneRelationSet
```
public boolean isXToOneRelationSet()
```

getSpis
```
public Map<String,Object> getSpis()
```

setSimplePk

public void setSimplePk(boolean simplePk)

setInBk
```
public void setInBk(boolean inBk)
```

isInBk
```
public boolean isInBk()
```

Celerio API

Class Attribute

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.jaxio.celerio.support.AbstractNamer

Methods inherited from class java.lang.Object

Field Detail

IS_FILE_SIZE

IS_FILE_NAME

IS_FILE_BINARY

IS_FILE_CONTENT_TYPE

IS_EMAIL

IS_PASSWORD

Constructor Detail

Attribute

Method Detail

setEntity

setColumnConfig

getVar

getEnumType

getFullName

getFullVar

getFullModelVar

getFullColumnName

getValidate

getLabelName

getLabels

getAutoIncrement

isSimplePk

setInCpk

isInCpk

setSimpleFk

isSimpleFk

setInCompositeFk

isInCompositeFk

isSimple

getSetterAccessibility

isSetterAccessibilityPublic

getName

getColumnName

getColumnNameEscaped

getColumnFullName

getTableName

getJdbcType

isJavaBaseClass

isEnum

isSortable

getEnumConfig

getEnumModel

getEnumClass

getEnumItemsType

getEnumItemsVar

getSize

isFixedSize

getComment

getJavadoc

hasComment

isUnique

isRequired

isCharPadding

isNullable

isNotNullable

hasDefaultValue

hasPertinentDefaultValue

getJavaDefaultValue

getDisplayOrderAsString

getType

getFullType

getFullTypeIfImportNeeded

isLocaleKey

columnNameHasLanguageSuffix

isLabel

getColumnNameWithoutLanguage

getColumnNameLanguage

isVersion

isInFileDefinition

isFile