Entity.Definition.Builder (JMinor Framework API 0.12.5-SNAPSHOT)

Enclosing interface:

Entity.Definition
```
public static interface Entity.Definition.Builder
```
Builds a Entity.Definition

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Entity.Definition.Builder`	`addConditionProvider(java.lang.String conditionId, Entity.ConditionProvider conditionProvider)` Adds a `Entity.ConditionProvider` which provides a dynamic query condition string.
`Entity.Definition.Builder`	`setBeanClass(java.lang.Class beanClass)` Sets the bean class to associate with this entity type
`Entity.Definition.Builder`	`setCaption(java.lang.String caption)` Sets the caption for this entity type
`Entity.Definition.Builder`	`setColorProvider(Entity.ColorProvider colorProvider)`
`Entity.Definition.Builder`	`setComparator(java.util.Comparator<Entity> comparator)` Sets the comparator to use when comparing this entity type to other entities
`Entity.Definition.Builder`	`setGroupByClause(java.lang.String groupByClause)` Sets the group by clause for this entity type, this clause should not include the "group by" keywords.
`Entity.Definition.Builder`	`setHavingClause(java.lang.String havingClause)` Sets the having clause for this entity type, this clause should not include the "having" keyword.
`Entity.Definition.Builder`	`setKeyGenerator(Entity.KeyGenerator keyGenerator)` Sets the primary key generator
`Entity.Definition.Builder`	`setOrderBy(Entity.OrderBy orderBy)` Sets the order by clause for this entity type.
`Entity.Definition.Builder`	`setReadOnly(boolean readOnly)` Sets the read only value, if true then it should not be possible to insert, update or delete entities of this type
`Entity.Definition.Builder`	`setSearchPropertyIds(java.lang.String... searchPropertyIds)` Sets the IDs of the properties to use when performing a default lookup for this entity type
`Entity.Definition.Builder`	`setSelectQuery(java.lang.String selectQuery, boolean containsWhereClause)` Sets the select query to use when selecting entities of this type, use with care.
`Entity.Definition.Builder`	`setSelectTableName(java.lang.String selectTableName)` Sets the name of the table to use when selecting entities of this type, when it differs from the one used to update/insert, such as a view.
`Entity.Definition.Builder`	`setSmallDataset(boolean smallDataset)` Specifies whether or not this entity should be regarded as based on a small dataset, which primarily means that combo box models can be based on this entity.
`Entity.Definition.Builder`	`setStaticData(boolean staticData)` Specifies whether or not this entity should be regarded as based on a static dataset, that is, one that changes only infrequently.
`Entity.Definition.Builder`	`setStringProvider(Entity.ToString stringProvider)` Sets the string provider, that is, the object responsible for providing toString values for this entity type
`Entity.Definition.Builder`	`setValidator(Entity.Validator validator)`

- Method Detail
  - setValidator
```
Entity.Definition.Builder setValidator(Entity.Validator validator)
```
    Parameters:
    
    validator - the validator for this entity type
    
    Returns:
    
    this Entity.Definition.Builder instance
  - addConditionProvider
```
Entity.Definition.Builder addConditionProvider(java.lang.String conditionId,
                                               Entity.ConditionProvider conditionProvider)
```
    Adds a Entity.ConditionProvider which provides a dynamic query condition string. The condition string should not include the WHERE keyword and use the ? substitution character where values should be inserted.
    
    Parameters:
    
    conditionId - the condition id
    
    conditionProvider - the condition provider
    
    Returns:
    
    this Entity.Definer instance
  - setColorProvider
```
Entity.Definition.Builder setColorProvider(Entity.ColorProvider colorProvider)
```
    Parameters:
    
    colorProvider - the background color provider
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setCaption
```
Entity.Definition.Builder setCaption(java.lang.String caption)
```
    Sets the caption for this entity type
    
    Parameters:
    
    caption - the caption
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setBeanClass
```
Entity.Definition.Builder setBeanClass(java.lang.Class beanClass)
```
    Sets the bean class to associate with this entity type
    
    Parameters:
    
    beanClass - the bean class
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setSmallDataset
```
Entity.Definition.Builder setSmallDataset(boolean smallDataset)
```
    Specifies whether or not this entity should be regarded as based on a small dataset, which primarily means that combo box models can be based on this entity. This is false by default.
    
    Parameters:
    
    smallDataset - true if the underlying table is small enough for displaying the contents in a combo box
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setStaticData
```
Entity.Definition.Builder setStaticData(boolean staticData)
```
    Specifies whether or not this entity should be regarded as based on a static dataset, that is, one that changes only infrequently. This is false by default.
    
    Parameters:
    
    staticData - true if the underlying table data is static
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setReadOnly
```
Entity.Definition.Builder setReadOnly(boolean readOnly)
```
    Sets the read only value, if true then it should not be possible to insert, update or delete entities of this type
    
    Parameters:
    
    readOnly - true if this entity type should be read only
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setKeyGenerator
```
Entity.Definition.Builder setKeyGenerator(Entity.KeyGenerator keyGenerator)
```
    Sets the primary key generator
    
    Parameters:
    
    keyGenerator - the primary key generator
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setOrderBy
```
Entity.Definition.Builder setOrderBy(Entity.OrderBy orderBy)
```
    Sets the order by clause for this entity type.
    
    Parameters:
    
    orderBy - the order by clause
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setHavingClause
```
Entity.Definition.Builder setHavingClause(java.lang.String havingClause)
```
    Sets the having clause for this entity type, this clause should not include the "having" keyword.
    
    Parameters:
    
    havingClause - the having clause
    
    Returns:
    
    this Entity.Definition.Builder instance
    
    Throws:
    
    java.lang.IllegalStateException - in case a having clause has already been set, for example automatically, based on grouping properties
  - setGroupByClause
```
Entity.Definition.Builder setGroupByClause(java.lang.String groupByClause)
```
    Sets the group by clause for this entity type, this clause should not include the "group by" keywords.
    
    Parameters:
    
    groupByClause - the group by clause
    
    Returns:
    
    this Entity.Definition.Builder instance
    
    Throws:
    
    java.lang.IllegalStateException - in case a group by clause has already been set, for example automatically, based on grouping properties
    
    See Also:
    
    ColumnProperty.Builder#setGroupingColumn(boolean)
  - setSelectTableName
```
Entity.Definition.Builder setSelectTableName(java.lang.String selectTableName)
```
    Sets the name of the table to use when selecting entities of this type, when it differs from the one used to update/insert, such as a view.
    
    Parameters:
    
    selectTableName - the name of the table
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setSelectQuery
```
Entity.Definition.Builder setSelectQuery(java.lang.String selectQuery,
                                         boolean containsWhereClause)
```
    Sets the select query to use when selecting entities of this type, use with care. The order of the properties when defining the entity must match the column order in the given query.
    
    Parameters:
    
    selectQuery - the select query to use for this entity type
    
    containsWhereClause - true if the given query contains a where clause
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setStringProvider
```
Entity.Definition.Builder setStringProvider(Entity.ToString stringProvider)
```
    Sets the string provider, that is, the object responsible for providing toString values for this entity type
    
    Parameters:
    
    stringProvider - the string provider
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setComparator
```
Entity.Definition.Builder setComparator(java.util.Comparator<Entity> comparator)
```
    Sets the comparator to use when comparing this entity type to other entities
    
    Parameters:
    
    comparator - the comparator
    
    Returns:
    
    this Entity.Definition.Builder instance
  - setSearchPropertyIds
```
Entity.Definition.Builder setSearchPropertyIds(java.lang.String... searchPropertyIds)
```
    Sets the IDs of the properties to use when performing a default lookup for this entity type
    
    Parameters:
    
    searchPropertyIds - the search property IDs
    
    Returns:
    
    this Entity.Definition.Builder instance

Interface Entity.Definition.Builder

Method Summary

Method Detail

setValidator

addConditionProvider

setColorProvider

setCaption

setBeanClass

setSmallDataset

setStaticData

setReadOnly

setKeyGenerator

setOrderBy

setHavingClause

setGroupByClause

setSelectTableName

setSelectQuery

setStringProvider

setComparator

setSearchPropertyIds