ColumnConfig (Celerio API)

java.lang.Object
- com.jaxio.celerio.configuration.entity.ColumnConfig

public class ColumnConfig
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static FORM_FIELD

static SEARCH_FIELD

static SEARCH_RESULT

Fields
Modifier and Type	Field and Description
`static`	`FORM_FIELD`
`static`	`SEARCH_FIELD`
`static`	`SEARCH_RESULT`

Constructor Summary

Constructors
Constructor and Description

ColumnConfig()

Constructors
Constructor and Description
`ColumnConfig()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`forceCustomAnnotationsToNullIfEmpty()` Convenient for hbm2celerio to avoid dead tags.
`void`	`forceUsagesToNullIfEmpty()` Convenient for hbm2celerio to avoid dead tags.
`AssociationDirection`	`getAssociationDirection()` If this column represents an importedKey, should it be bidirectionnal or unidirectionnal
`Boolean`	`getAsTransient()` Allows you to override the getter in a sub-class that extends the base entity.
`Boolean`	`getAutoIncrement()` Override the autoIncrement value defined in the Metadata.
`Boolean`	`getBusinessKey()` Indicates if this property is part of the entity business key.
`String`	`getColumnName()` The mandatory column name.
`String`	`getComment()` Override the comment defined in the Metadata.
`List<CustomAnnotation>`	`getCustomAnnotations()` List of custom annotations to apply on this property.
`Integer`	`getDecimalDigits()` Override the column decimal digits defined in the Metadata.
`String`	`getDefaultValue()` Override the default value defined in the Metadata.
`Integer`	`getDisplayOrder()` The order of appearance of this column in forms, from top to bottom and in search results, from left to right.
`Boolean`	`getEnableOneToVirtualOne()` If this column represents an importedKey, and the column is unique, should the one to one be handled via a collection ?
`EnumConfig`	`getEnumConfig()` Specify the enum config to map this column to a Java enum.
`String`	`getFieldName()` The corresponding variable name in the Java world.
`Boolean`	`getFormField()` Should this column appear in edit form?
`GeneratedValue`	`getGeneratedValue()` When the column represents a single primary key, you can configure the GeneratedValue JPA annotation here.
`GenericGenerator`	`getGenericGenerator()` When the column represents a single primary key, you can configure the GenericGenerator JPA annotation here.
`Boolean`	`getHtml()` Does this column contain html?
`Boolean`	`getIgnore()` If set to true, the column will be ignored.
`IndexedField`	`getIndexedField()` Configure the Hibernate search Field annotation.
`Boolean`	`getInverse()` If this column represents a foreign key that points to the target of a ManyToMany association it can be set to true to change the default inverse side of the ManyToMany association.
`OneToOneConfig`	`getInverseOneToOneConfig()`
`String`	`getLabel()` The base label for this column.
`List<Label>`	`getLabels()` The labels for this attribute.
`Boolean`	`getLazy()` Should the mapped property be lazy loaded ?
`ManyToManyConfig`	`getManyToManyConfig()`
`ManyToOneConfig`	`getManyToOneConfig()`
`MappedType`	`getMappedType()` Force the Java mapped type for this column instead of relying on Celerio's conventions.
`Boolean`	`getMessageKey()` Indicates whether the possible values held by this column are used as keys to resolve the associated localized values.
`Integer`	`getMin()` Minimum length for String.
`Boolean`	`getNullable()` Override the nullable value defined in the Metadata.
`OneToManyConfig`	`getOneToManyConfig()`
`OneToOneConfig`	`getOneToOneConfig()`
`Integer`	`getOrdinalPosition()` Override the column ordinal position defined in the Metadata.
`Boolean`	`getPassword()` Should this column be considered as storing a password ?
`SafeHtml`	`getSafeHtml()` When this element is present, the SafeHtml annotation is added on this field.
`Boolean`	`getSearchField()` Should this column appear in search form?
`Boolean`	`getSearchResult()` Should this column appear in search results?
`Boolean`	`getSelectLabel()` Should this column be part of the label representation
`String`	`getSharedEnumName()` References a shared enum name by its name.
`Integer`	`getSize()` Override the column size defined in the Metadata.
`String`	`getTableName()` Allows you to use JPA secondary table if you set a table name that is different from the entity table name.
`String`	`getTableNameEscaped()`
`String`	`getTargetColumnName()` Once you have set the targetTableName, you can adjust the targetColumnName if it is different from the primaryKey column.
`String`	`getTargetTableName()` If you use a legacy database schema that does not declare foreign keys, you can manually set the target table name.
`JdbcType`	`getType()` Override the default JdbcType.
`String`	`getTypeConverter()` Sets the 'type' attribute passed to the 'org.hibernate.annotations.Type' annotation.
`Boolean`	`getUnique()` Override the uniqueness defined in the indexes from the metadata.
`List<String>`	`getUsages()` For future uses
`Boolean`	`getVersion()` Should this column be used to provide optimistic locking?
`Boolean`	`getVisible()` Should this column be visible to the users ?
`boolean`	`hasColumnName()`
`boolean`	`hasComment()`
`boolean`	`hasDefaultValue()`
`boolean`	`hasEnum()`
`boolean`	`hasEnumConfig()`
`boolean`	`hasGeneratedValue()`
`boolean`	`hasGenericGenerator()`
`boolean`	`hasHtml()`
`boolean`	`hasIndexedField()`
`boolean`	`hasLazy()`
`boolean`	`hasMin()`
`boolean`	`hasSafeHtml()`
`boolean`	`hasSharedEnum()`
`boolean`	`hasTableName()`
`boolean`	`hasTargetColumnName()`
`boolean`	`hasTargetEntityName()`
`boolean`	`hasTargetTableName()`
`boolean`	`hasTrueBusinessKey()`
`boolean`	`hasTrueFormField()`
`boolean`	`hasTrueIgnore()`
`boolean`	`hasTrueSearchField()`
`boolean`	`hasTrueSearchResult()`
`Boolean`	`isPassword()`
`boolean`	`isTransient()`
`String`	`lookupTargetEntityName()`
`void`	`setAssociationDirection(AssociationDirection associationDirection)`
`void`	`setAsTransient(Boolean asTransient)`
`void`	`setAutoIncrement(Boolean autoIncrement)`
`void`	`setBusinessKey(Boolean businessKey)`
`void`	`setColumnName(String columnName)`
`void`	`setComment(String comment)`
`void`	`setCustomAnnotations(List<CustomAnnotation> customAnnotations)`
`void`	`setDecimalDigits(Integer decimalDigits)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setDisplayOrder(Integer displayOrder)`
`void`	`setEnableOneToVirtualOne(Boolean enableOneToVirtualOne)`
`void`	`setEnumConfig(EnumConfig e)`
`void`	`setFieldName(String fieldName)`
`void`	`setFormField(Boolean formField)`
`void`	`setGeneratedValue(GeneratedValue generatedValue)`
`void`	`setGenericGenerator(GenericGenerator genericGenerator)`
`void`	`setHtml(Boolean html)`
`void`	`setIgnore(Boolean ignore)`
`void`	`setIndexedField(IndexedField indexedField)`
`void`	`setInverse(Boolean inverse)`
`void`	`setInverseOneToOneConfig(OneToOneConfig inverseOneToOneConfig)`
`void`	`setLabel(String label)`
`void`	`setLabels(List<Label> labels)`
`void`	`setLazy(Boolean lazy)`
`void`	`setManyToManyConfig(ManyToManyConfig manyToManyConfig)`
`void`	`setManyToOneConfig(ManyToOneConfig manyToOneConfig)`
`void`	`setMappedType(MappedType mappedType)`
`void`	`setMessageKey(Boolean messageKey)`
`void`	`setMin(Integer min)`
`void`	`setNullable(Boolean nullable)`
`void`	`setOneToManyConfig(OneToManyConfig oneToManyConfig)`
`void`	`setOneToOneConfig(OneToOneConfig oneToOneConfig)`
`void`	`setOrdinalPosition(Integer ordinalPosition)`
`void`	`setPassword(Boolean password)`
`void`	`setSafeHtml(SafeHtml safeHtml)`
`void`	`setSearchField(Boolean searchField)`
`void`	`setSearchResult(Boolean searchResult)`
`void`	`setSelectLabel(Boolean selectLabel)`
`void`	`setSharedEnumName(String sharedEnumName)`
`void`	`setSize(Integer size)`
`void`	`setTableName(String tableName)`
`void`	`setTargetColumnName(String targetColumnName)`
`void`	`setTargetTableName(String targetTableName)`
`void`	`setType(JdbcType type)`
`void`	`setTypeConverter(String typeConverter)`
`void`	`setUnique(Boolean unique)`
`void`	`setUsages(List<String> usages)`
`void`	`setVersion(Boolean version)`
`void`	`setVisible(Boolean visible)`
`boolean`	`useConfigForIdGenerator()`

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

- Field Detail
  - SEARCH_RESULT
```
public static  SEARCH_RESULT
```
  - SEARCH_FIELD
```
public static  SEARCH_FIELD
```
  - FORM_FIELD
```
public static  FORM_FIELD
```
- Constructor Detail
  - ColumnConfig
```
public ColumnConfig()
```
- Method Detail
  - getLabels
```
public List<Label> getLabels()
```
    The labels for this attribute. They appear in the entity properties file located under 'src/main/resources/localization/domain'.
  - getUsages
```
public List<String> getUsages()
```
    For future uses
  - setUsages
```
public void setUsages(List<String> usages)
```
  - forceUsagesToNullIfEmpty
```
public void forceUsagesToNullIfEmpty()
```
    Convenient for hbm2celerio to avoid dead tags.
  - getEnumConfig
```
public EnumConfig getEnumConfig()
```
    Specify the enum config to map this column to a Java enum. If this enum is used by other columns, you must declare instead a shared enum and reference it using the sharedEnumName attribute.
  - setEnumConfig
```
public void setEnumConfig(EnumConfig e)
```
  - hasEnum
```
public boolean hasEnum()
```
  - hasSharedEnum
```
public boolean hasSharedEnum()
```
  - hasEnumConfig
```
public boolean hasEnumConfig()
```
  - getSharedEnumName
```
public String getSharedEnumName()
```
    References a shared enum name by its name. You cannot have both an enum configuration, and a shared enum name.
  - getSafeHtml
```
public SafeHtml getSafeHtml()
```
    When this element is present, the SafeHtml annotation is added on this field.
  - hasSafeHtml
```
public boolean hasSafeHtml()
```
  - getLabel
```
public String getLabel()
```
    The base label for this column. You may either set it here or in a nested labels/label.
  - getGeneratedValue
```
public GeneratedValue getGeneratedValue()
```
    When the column represents a single primary key, you can configure the GeneratedValue JPA annotation here.
  - hasGeneratedValue
```
public boolean hasGeneratedValue()
```
  - getGenericGenerator
```
public GenericGenerator getGenericGenerator()
```
    When the column represents a single primary key, you can configure the GenericGenerator JPA annotation here.
  - hasGenericGenerator
```
public boolean hasGenericGenerator()
```
  - getIndexedField
```
public IndexedField getIndexedField()
```
    Configure the Hibernate search Field annotation. If present, the field is annotated, if absent it is not.
  - hasIndexedField
```
public boolean hasIndexedField()
```
  - getCustomAnnotations
```
public List<CustomAnnotation> getCustomAnnotations()
```
    List of custom annotations to apply on this property.
  - setCustomAnnotations
```
public void setCustomAnnotations(List<CustomAnnotation> customAnnotations)
```
  - forceCustomAnnotationsToNullIfEmpty
```
public void forceCustomAnnotationsToNullIfEmpty()
```
    Convenient for hbm2celerio to avoid dead tags.
  - getIgnore
```
public Boolean getIgnore()
```
    If set to true, the column will be ignored. Make sure you do not ignore not null columns.
  - hasTrueIgnore
```
public boolean hasTrueIgnore()
```
  - getType
```
public JdbcType getType()
```
    Override the default JdbcType.
  - getMappedType
```
public MappedType getMappedType()
```
    Force the Java mapped type for this column instead of relying on Celerio's conventions.
  - getLazy
```
public Boolean getLazy()
```
    Should the mapped property be lazy loaded ? If yes, the annotation @Basic(fetch = FetchType.LAZY) is used. Defaults to 'true' for CLOB, BLOB or BYTES mapped types.
  - hasLazy
```
public boolean hasLazy()
```
  - getFieldName
```
public String getFieldName()
```
    The corresponding variable name in the Java world. By default, the field name is deduced from the column name.
    For primary key the field name is always forced to Example: 'first_name' will become 'firstName';
  - getTableName
```
public String getTableName()
```
    Allows you to use JPA secondary table if you set a table name that is different from the entity table name. Default to the entity table name.
  - hasTableName
```
public boolean hasTableName()
```
  - getTableNameEscaped
```
public String getTableNameEscaped()
```
  - getColumnName
```
public String getColumnName()
```
    The mandatory column name.
  - hasColumnName
```
public boolean hasColumnName()
```
  - getSize
```
public Integer getSize()
```
    Override the column size defined in the Metadata. Defaults to the size found when reversing the database schema.
  - hasMin
```
public boolean hasMin()
```
  - getMin
```
public Integer getMin()
```
    Minimum length for String. When present it is used in the @Size validation annotation. No default value.
  - getOrdinalPosition
```
public Integer getOrdinalPosition()
```
    Override the column ordinal position defined in the Metadata. Defaults to the ordinal position found when reversing the database schema.
  - getDisplayOrder
```
public Integer getDisplayOrder()
```
    The order of appearance of this column in forms, from top to bottom and in search results, from left to right. It defaults to the ordinal position.
  - getTypeConverter
```
public String getTypeConverter()
```
    Sets the 'type' attribute passed to the 'org.hibernate.annotations.Type' annotation. By default, no Type annotation is used.
  - getBusinessKey
```
public Boolean getBusinessKey()
```
    Indicates if this property is part of the entity business key. You may set it on several properties at the same time if your business key involves more than one column. If set to true, the property will be used in equals/hashCode methods. As soon as you declare this attribute on a property, convention no longer applies for the entity.
  - hasTrueBusinessKey
```
public boolean hasTrueBusinessKey()
```
  - getAsTransient
```
public Boolean getAsTransient()
```
    Allows you to override the getter in a sub-class that extends the base entity.
    If set to true, all the annotations for the corresponding getter will be commented and a @Transient annotation will be set.
  - isTransient
```
public boolean isTransient()
```
  - getComment
```
public String getComment()
```
    Override the comment defined in the Metadata. The comment that will be inserted as JavaDoc in the corresponding getter method. Defaults to the comment found when reversing the database schema.
  - hasComment
```
public boolean hasComment()
```
  - getDecimalDigits
```
public Integer getDecimalDigits()
```
    Override the column decimal digits defined in the Metadata. Defaults to the decimal digits found when reversing the database schema.
  - getDefaultValue
```
public String getDefaultValue()
```
    Override the default value defined in the Metadata. Defaults to the default value found when reversing the database schema.
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
  - getMessageKey
```
public Boolean getMessageKey()
```
    Indicates whether the possible values held by this column are used as keys to resolve the associated localized values.
  - getHtml
```
public Boolean getHtml()
```
    Does this column contain html? When true, some special escaping on the front is performed.
  - hasHtml
```
public boolean hasHtml()
```
  - getInverse
```
public Boolean getInverse()
```
    If this column represents a foreign key that points to the target of a ManyToMany association it can be set to true to change the default inverse side of the ManyToMany association. By convention, the column with the highest ordinal position refers to the inverse side.
  - getAssociationDirection
```
public AssociationDirection getAssociationDirection()
```
    If this column represents an importedKey, should it be bidirectionnal or unidirectionnal
  - getEnableOneToVirtualOne
```
public Boolean getEnableOneToVirtualOne()
```
    If this column represents an importedKey, and the column is unique, should the one to one be handled via a collection ?
  - getAutoIncrement
```
public Boolean getAutoIncrement()
```
    Override the autoIncrement value defined in the Metadata. You should use it only in case your driver is unable to determine whether the primary key is auto incremented or not.
  - getNullable
```
public Boolean getNullable()
```
    Override the nullable value defined in the Metadata. Defaults to the nullable value found when reversing the database schema.
  - getFormField
```
public Boolean getFormField()
```
    Should this column appear in edit form? By default, most columns appear in the edit form. Note that this configuration is taken into account only if at least one of the entity's columnConfig formField attribute (could be this one) is set to true.
  - hasTrueFormField
```
public boolean hasTrueFormField()
```
  - getSearchField
```
public Boolean getSearchField()
```
    Should this column appear in search form?
  - hasTrueSearchField
```
public boolean hasTrueSearchField()
```
  - getSearchResult
```
public Boolean getSearchResult()
```
    Should this column appear in search results?
  - hasTrueSearchResult
```
public boolean hasTrueSearchResult()
```
  - getSelectLabel
```
public Boolean getSelectLabel()
```
    Should this column be part of the label representation
  - getUnique
```
public Boolean getUnique()
```
    Override the uniqueness defined in the indexes from the metadata.
  - getVisible
```
public Boolean getVisible()
```
    Should this column be visible to the users ?
  - getVersion
```
public Boolean getVersion()
```
    Should this column be used to provide optimistic locking? If true, this column will be mapped with a @Version annotation providing the mapped type is compatible with @Version expected type. Defaults to true if the fieldName is "version" and if the mapped type is compatible with @Version.
  - getTargetTableName
```
public String getTargetTableName()
```
    If you use a legacy database schema that does not declare foreign keys, you can manually set the target table name. If you do, you may also need to set the targetColumnName. This attribute is not taken into account if a foreign key is already declared in your schema.
  - hasTargetTableName
```
public boolean hasTargetTableName()
```
  - getTargetColumnName
```
public String getTargetColumnName()
```
    Once you have set the targetTableName, you can adjust the targetColumnName if it is different from the primaryKey column. Defaults to the targetTableName's primary key column.
  - hasTargetColumnName
```
public boolean hasTargetColumnName()
```
  - useConfigForIdGenerator
```
public boolean useConfigForIdGenerator()
```
  - hasTargetEntityName
```
public boolean hasTargetEntityName()
```
  - lookupTargetEntityName
```
public String lookupTargetEntityName()
```
  - getPassword
```
public Boolean getPassword()
```
    Should this column be considered as storing a password ? This will impact input types attribute on the web tier.
  - isPassword
```
public Boolean isPassword()
```
  - setLabels
```
public void setLabels(List<Label> labels)
```
  - setSharedEnumName
```
public void setSharedEnumName(String sharedEnumName)
```
  - setSafeHtml
```
public void setSafeHtml(SafeHtml safeHtml)
```
  - setGeneratedValue
```
public void setGeneratedValue(GeneratedValue generatedValue)
```
  - setGenericGenerator
```
public void setGenericGenerator(GenericGenerator genericGenerator)
```
  - setIndexedField
```
public void setIndexedField(IndexedField indexedField)
```
  - setManyToOneConfig
```
public void setManyToOneConfig(ManyToOneConfig manyToOneConfig)
```
  - setOneToManyConfig
```
public void setOneToManyConfig(OneToManyConfig oneToManyConfig)
```
  - setOneToOneConfig
```
public void setOneToOneConfig(OneToOneConfig oneToOneConfig)
```
  - setInverseOneToOneConfig
```
public void setInverseOneToOneConfig(OneToOneConfig inverseOneToOneConfig)
```
  - setManyToManyConfig
```
public void setManyToManyConfig(ManyToManyConfig manyToManyConfig)
```
  - setIgnore
```
public void setIgnore(Boolean ignore)
```
  - setType
```
public void setType(JdbcType type)
```
  - setMappedType
```
public void setMappedType(MappedType mappedType)
```
  - setLazy
```
public void setLazy(Boolean lazy)
```
  - setFieldName
```
public void setFieldName(String fieldName)
```
  - setTableName
```
public void setTableName(String tableName)
```
  - setColumnName
```
public void setColumnName(String columnName)
```
  - setSize
```
public void setSize(Integer size)
```
  - setMin
```
public void setMin(Integer min)
```
  - setOrdinalPosition
```
public void setOrdinalPosition(Integer ordinalPosition)
```
  - setDisplayOrder
```
public void setDisplayOrder(Integer displayOrder)
```
  - setTypeConverter
```
public void setTypeConverter(String typeConverter)
```
  - setComment
```
public void setComment(String comment)
```
  - setDecimalDigits
```
public void setDecimalDigits(Integer decimalDigits)
```
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
  - setBusinessKey
```
public void setBusinessKey(Boolean businessKey)
```
  - setAsTransient
```
public void setAsTransient(Boolean asTransient)
```
  - setMessageKey
```
public void setMessageKey(Boolean messageKey)
```
  - setHtml
```
public void setHtml(Boolean html)
```
  - setLabel
```
public void setLabel(String label)
```
  - setInverse
```
public void setInverse(Boolean inverse)
```
  - setAssociationDirection
```
public void setAssociationDirection(AssociationDirection associationDirection)
```
  - setEnableOneToVirtualOne
```
public void setEnableOneToVirtualOne(Boolean enableOneToVirtualOne)
```
  - setAutoIncrement
```
public void setAutoIncrement(Boolean autoIncrement)
```
  - setNullable
```
public void setNullable(Boolean nullable)
```
  - setFormField
```
public void setFormField(Boolean formField)
```
  - setSearchField
```
public void setSearchField(Boolean searchField)
```
  - setSearchResult
```
public void setSearchResult(Boolean searchResult)
```
  - setSelectLabel
```
public void setSelectLabel(Boolean selectLabel)
```
  - setUnique
```
public void setUnique(Boolean unique)
```
  - setVersion
```
public void setVersion(Boolean version)
```
  - setVisible
```
public void setVisible(Boolean visible)
```
  - setPassword
```
public void setPassword(Boolean password)
```
  - setTargetTableName
```
public void setTargetTableName(String targetTableName)
```
  - setTargetColumnName
```
public void setTargetColumnName(String targetColumnName)
```
  - getManyToOneConfig
```
public ManyToOneConfig getManyToOneConfig()
```
  - getOneToManyConfig
```
public OneToManyConfig getOneToManyConfig()
```
  - getOneToOneConfig
```
public OneToOneConfig getOneToOneConfig()
```
  - getInverseOneToOneConfig
```
public OneToOneConfig getInverseOneToOneConfig()
```
  - getManyToManyConfig
```
public ManyToManyConfig getManyToManyConfig()
```

Celerio API

Class ColumnConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SEARCH_RESULT

SEARCH_FIELD

FORM_FIELD

Constructor Detail

ColumnConfig

Method Detail

getLabels

getUsages

setUsages

forceUsagesToNullIfEmpty

getEnumConfig

setEnumConfig

hasEnum

hasSharedEnum

hasEnumConfig

getSharedEnumName

getSafeHtml

hasSafeHtml

getLabel

getGeneratedValue

hasGeneratedValue

getGenericGenerator

hasGenericGenerator

getIndexedField

hasIndexedField

getCustomAnnotations

setCustomAnnotations

forceCustomAnnotationsToNullIfEmpty

getIgnore

hasTrueIgnore

getType

getMappedType

getLazy

hasLazy

getFieldName

getTableName

hasTableName

getTableNameEscaped

getColumnName

hasColumnName

getSize

hasMin

getMin

getOrdinalPosition

getDisplayOrder

getTypeConverter

getBusinessKey

hasTrueBusinessKey

getAsTransient

isTransient

getComment

hasComment

getDecimalDigits

getDefaultValue

hasDefaultValue

getMessageKey

getHtml

hasHtml

getInverse

getAssociationDirection

getEnableOneToVirtualOne

getAutoIncrement

getNullable

getFormField

hasTrueFormField

getSearchField

hasTrueSearchField

getSearchResult

hasTrueSearchResult

getSelectLabel

getUnique

getVisible

getVersion