DefaultClassMetaModel (domui :: domui-core 1.1 API)

java.lang.Object
- to.etc.domui.component.meta.impl.DefaultClassMetaModel

All Implemented Interfaces:

ClassMetaModel
```
public class DefaultClassMetaModel
extends Object
implements ClassMetaModel
```
This is a DomUI class metamodel info record that only contains data. It can be constructed by metamodel factories and filled in by calling the appropriate setters. When an instance of this class has been returned by a factory then it is NOT ALLOWED TO CHANGE IT ANYMORE(!) to maintain thread-safety.

Author:

Frits Jalvingh Created on Jun 2, 2010

Constructor Summary

Constructors
Constructor and Description

DefaultClassMetaModel(Class<?> metaClass)

Constructors
Constructor and Description
`DefaultClassMetaModel(Class<?> metaClass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QCriteria<?>`	`createCriteria()` If this is a persistent class, this should create a base QCriteria instance to do queries on this class.
`PropertyMetaModel<?>`	`findProperty(String name)` This resolves a property path, starting at this class.
`PropertyMetaModel<?>`	`findSimpleProperty(String name)` Not synchronized because the simple map is initialized when the ClassMetaModel is created and after that it's immutable.
`Class<?>`	`getActualClass()` FIXME Questionable nullity
`BundleRef`	`getClassBundle()` Return the class' resource bundle.
`String`	`getClassNameOnly()`
`Class<? extends IComboDataSet<?>>`	`getComboDataSet()` If this class is the UP in a relation this specifies that it must be shown as a COMBOBOX containing choices.
`List<DisplayPropertyMetaModel>`	`getComboDisplayProperties()` If this object is shown in a combobox it needs to show the following properties as the display value.
`Class<? extends ILabelStringRenderer<?>>`	`getComboLabelRenderer()` When this relation-property is presented as a single field this can contain a class to render that field as a string.
`Class<? extends INodeContentRenderer<?>>`	`getComboNodeRenderer()` When set, the entire content of a combobox's OPTION tag can be generated by this content renderer.
`String`	`getComboSortProperty()` The property name to sort the combobox's presentation on.
`String`	`getComponentTypeHint()` When present this gives a hint to the component factories to help with choosing a proper component to select a single record of this type.
`SortableType`	`getDefaultSortDirection()` When a `ClassMetaModel.getDefaultSortProperty()` is defined, this defines the sort order to use initially.
`String`	`getDefaultSortProperty()` Contains the name of the property to use for sorting initially.
`String`	`getDomainLabel(Locale loc, Object value)` Retrieves a label value for the specified domain value.
`Object[]`	`getDomainValues()` If this class is an Enum or represents some enumerated value, this returns the possible value objects.
`List<SearchPropertyMetaModel>`	`getKeyWordSearchProperties()` Returns the sorted list of key word search properties defined on this class.
`List<DisplayPropertyMetaModel>`	`getLookupSelectedProperties()` When this class is to be selected as a parent in an UP relation using an InputLookup control this describes the properties to use to display the currently selected record in the edit page.
`Class<? extends INodeContentRenderer<?>>`	`getLookupSelectedRenderer()` When this class is to be selected as a parent in an UP relation using an InputLookup control this describes the renderer to use to display the currently selected record in the edit page.
`ICriteriaTableDef<?>`	`getMetaTableDef()`
`PropertyMetaModel<?>`	`getPrimaryKey()` Returns the property containing the primary key for this object, if one can be found.
`List<PropertyMetaModel<?>>`	`getProperties()`
`PropertyMetaModel<?>`	`getProperty(String name)` Same as `ClassMetaModel.findProperty(String)`, but throws an exception if the property (or path) is not found, so it never returns null.
`IQueryManipulator<?>`	`getQueryManipulator()` For Lookup and Combo fields, this can return a QueryManipulator instance that will alter the base query for the list-of-this to show.
`List<SearchPropertyMetaModel>`	`getSearchProperties()` Returns the SORTED list of search properties defined on this class.
`List<DisplayPropertyMetaModel>`	`getTableDisplayProperties()` If this object is shown in a Table it needs to show the following properties there.
`String`	`getTableName()` If this is a persistent class that is directly mapped onto some table, this might return the table name.
`String`	`getUserEntityName()` Return a user-presentable entity name for this class.
`String`	`getUserEntityNamePlural()` Returns a user-presentable entity name as a plural name.
`boolean`	`isPersistentClass()`
`void`	`setComboDataSet(Class<? extends IComboDataSet<?>> comboDataSet)`
`void`	`setComboDisplayProperties(List<DisplayPropertyMetaModel> displayProperties)`
`void`	`setComboLabelRenderer(Class<? extends ILabelStringRenderer<?>> comboLabelRenderer)`
`void`	`setComboNodeRenderer(Class<? extends INodeContentRenderer<?>> comboNodeRenderer)`
`void`	`setComboSortProperty(String comboSortProperty)`
`void`	`setComponentTypeHint(String componentTypeHint)`
`void`	`setDefaultSortDirection(SortableType defaultSortDirection)`
`void`	`setDefaultSortProperty(String defaultSortProperty)`
`void`	`setDomainValues(Object[] domainValues)`
`void`	`setKeyWordSearchProperties(List<SearchPropertyMetaModel> keyWordSearchProperties)`
`void`	`setLookupSelectedProperties(List<DisplayPropertyMetaModel> lookupFieldDisplayProperties)`
`void`	`setLookupSelectedRenderer(Class<? extends INodeContentRenderer<?>> lookupFieldRenderer)`
`void`	`setMetaTableDef(ICriteriaTableDef<?> metaTableDef)`
`void`	`setPersistentClass(boolean persistentClass)`
`void`	`setPrimaryKey(PropertyMetaModel<?> primaryKey)`
`void`	`setQueryManipulator(IQueryManipulator<?> queryManipulator)`
`void`	`setSearchProperties(List<SearchPropertyMetaModel> searchProperties)`
`void`	`setTableDisplayProperties(List<DisplayPropertyMetaModel> tableDisplayProperties)`
`void`	`setTableName(String tableName)`
`String`	`toString()`

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

- Constructor Detail
  - DefaultClassMetaModel
```
public DefaultClassMetaModel(Class<?> metaClass)
```
- Method Detail
  - getClassBundle
```
@Nonnull
public BundleRef getClassBundle()
```
    Return the class' resource bundle.
    
    Specified by:
    
    getClassBundle in interface ClassMetaModel
    
    Returns:
  - getUserEntityName
```
@Nullable
public String getUserEntityName()
```
    Return a user-presentable entity name for this class. Returns null if not set.
    
    Specified by:
    
    getUserEntityName in interface ClassMetaModel
    
    See Also:
    
    ClassMetaModel.getUserEntityName()
  - getUserEntityNamePlural
```
@Nullable
public String getUserEntityNamePlural()
```
    Returns a user-presentable entity name as a plural name.
    
    Specified by:
    
    getUserEntityNamePlural in interface ClassMetaModel
    
    Returns:
    
    See Also:
    
    ClassMetaModel.getUserEntityNamePlural()
  - findProperty
```
@Nullable
public PropertyMetaModel<?> findProperty(@Nonnull
                                                   String name)
```
    This resolves a property path, starting at this class. If any part of the path does not exist this returns null.
    
    Specified by:
    
    findProperty in interface ClassMetaModel
    
    Returns:
    
    See Also:
    
    ClassMetaModel.findProperty(java.lang.String)
  - getProperty
```
@Nonnull
public PropertyMetaModel<?> getProperty(@Nonnull
                                                 String name)
```
    Description copied from interface: ClassMetaModel
    
    Same as ClassMetaModel.findProperty(String), but throws an exception if the property (or path) is not found, so it never returns null.
    
    Specified by:
    
    getProperty in interface ClassMetaModel
    
    Returns:
  - findSimpleProperty
```
@Nullable
public PropertyMetaModel<?> findSimpleProperty(@Nonnull
                                                         String name)
```
    Not synchronized because the simple map is initialized when the ClassMetaModel is created and after that it's immutable.
    
    Specified by:
    
    findSimpleProperty in interface ClassMetaModel
    
    Parameters:
    
    name -
    
    Returns:
  - getProperties
```
@Nonnull
public List<PropertyMetaModel<?>> getProperties()
```
    Specified by:
    
    getProperties in interface ClassMetaModel
  - getComboDataSet
```
@Nullable
public Class<? extends IComboDataSet<?>> getComboDataSet()
```
    Description copied from interface: ClassMetaModel
    
    If this class is the UP in a relation this specifies that it must be shown as a COMBOBOX containing choices. It contains a generator for the values to show. This is a default for all relations in which this class is the parent; it can be overridden in individual relations.
    
    Specified by:
    
    getComboDataSet in interface ClassMetaModel
    
    Returns:
  - setComboDataSet
```
public void setComboDataSet(@Nullable
                            Class<? extends IComboDataSet<?>> comboDataSet)
```
  - getComboLabelRenderer
```
public Class<? extends ILabelStringRenderer<?>> getComboLabelRenderer()
```
    Description copied from interface: ClassMetaModel
    
    When this relation-property is presented as a single field this can contain a class to render that field as a string.
    
    Specified by:
    
    getComboLabelRenderer in interface ClassMetaModel
    
    Returns:
  - setComboLabelRenderer
```
public void setComboLabelRenderer(Class<? extends ILabelStringRenderer<?>> comboLabelRenderer)
```
  - getComboDisplayProperties
```
@Nonnull
public List<DisplayPropertyMetaModel> getComboDisplayProperties()
```
    Description copied from interface: ClassMetaModel
    
    If this object is shown in a combobox it needs to show the following properties as the display value.
    
    Specified by:
    
    getComboDisplayProperties in interface ClassMetaModel
    
    Returns:
  - setComboDisplayProperties
```
public void setComboDisplayProperties(List<DisplayPropertyMetaModel> displayProperties)
```
  - getComboNodeRenderer
```
public Class<? extends INodeContentRenderer<?>> getComboNodeRenderer()
```
    Description copied from interface: ClassMetaModel
    
    When set, the entire content of a combobox's OPTION tag can be generated by this content renderer. When set, the ClassMetaModel.getComboDisplayProperties(), ClassMetaModel.getComboLabelRenderer() properties are ignored.
    
    Specified by:
    
    getComboNodeRenderer in interface ClassMetaModel
    
    Returns:
  - setComboNodeRenderer
```
public void setComboNodeRenderer(Class<? extends INodeContentRenderer<?>> comboNodeRenderer)
```
  - getSearchProperties
```
@Nonnull
public List<SearchPropertyMetaModel> getSearchProperties()
```
    Returns the SORTED list of search properties defined on this class.
    
    Specified by:
    
    getSearchProperties in interface ClassMetaModel
    
    Returns:
    
    See Also:
    
    ClassMetaModel.getSearchProperties()
  - setSearchProperties
```
public void setSearchProperties(@Nonnull
                                List<SearchPropertyMetaModel> searchProperties)
```
  - getKeyWordSearchProperties
```
@Nonnull
public List<SearchPropertyMetaModel> getKeyWordSearchProperties()
```
    Returns the sorted list of key word search properties defined on this class.
    
    Specified by:
    
    getKeyWordSearchProperties in interface ClassMetaModel
    
    Returns:
    
    See Also:
    
    ClassMetaModel.getKeyWordSearchProperties()
  - setKeyWordSearchProperties
```
public void setKeyWordSearchProperties(@Nonnull
                                       List<SearchPropertyMetaModel> keyWordSearchProperties)
```
  - getActualClass
```
@Nonnull
public Class<?> getActualClass()
```
    Description copied from interface: ClassMetaModel
    
    FIXME Questionable nullity
    
    Specified by:
    
    getActualClass in interface ClassMetaModel
    
    Returns:
  - getTableDisplayProperties
```
@Nonnull
public List<DisplayPropertyMetaModel> getTableDisplayProperties()
```
    Description copied from interface: ClassMetaModel
    
    If this object is shown in a Table it needs to show the following properties there. This value gets set from @MetaObject. These columns are also used when the table is shown as the result of a LookupInput search.
    
    Specified by:
    
    getTableDisplayProperties in interface ClassMetaModel
    
    Returns:
  - setTableDisplayProperties
```
public void setTableDisplayProperties(List<DisplayPropertyMetaModel> tableDisplayProperties)
```
  - isPersistentClass
```
public boolean isPersistentClass()
```
    Specified by:
    
    isPersistentClass in interface ClassMetaModel
  - setPersistentClass
```
public void setPersistentClass(boolean persistentClass)
```
  - getDefaultSortProperty
```
public String getDefaultSortProperty()
```
    Description copied from interface: ClassMetaModel
    
    Contains the name of the property to use for sorting initially. It is used to define the initial sort order when a table is shown for the 1st time. It can be null in which case the table query defines the sort order.
    
    Specified by:
    
    getDefaultSortProperty in interface ClassMetaModel
    
    Returns:
  - setDefaultSortProperty
```
public void setDefaultSortProperty(String defaultSortProperty)
```
  - getDefaultSortDirection
```
@Nullable
public SortableType getDefaultSortDirection()
```
    Description copied from interface: ClassMetaModel
    
    When a ClassMetaModel.getDefaultSortProperty() is defined, this defines the sort order to use initially.
    
    Specified by:
    
    getDefaultSortDirection in interface ClassMetaModel
    
    Returns:
  - setDefaultSortDirection
```
public void setDefaultSortDirection(@Nullable
                                    SortableType defaultSortDirection)
```
  - getLookupSelectedRenderer
```
public Class<? extends INodeContentRenderer<?>> getLookupSelectedRenderer()
```
    When this class is to be selected as a parent in an UP relation using an InputLookup control this describes the renderer to use to display the currently selected record in the edit page. If null this will use ClassMetaModel.getLookupSelectedProperties().
    
    Specified by:
    
    getLookupSelectedRenderer in interface ClassMetaModel
    
    Returns:
  - setLookupSelectedRenderer
```
public void setLookupSelectedRenderer(Class<? extends INodeContentRenderer<?>> lookupFieldRenderer)
```
  - getLookupSelectedProperties
```
@Nonnull
public List<DisplayPropertyMetaModel> getLookupSelectedProperties()
```
    When this class is to be selected as a parent in an UP relation using an InputLookup control this describes the properties to use to display the currently selected record in the edit page.
    
    Specified by:
    
    getLookupSelectedProperties in interface ClassMetaModel
    
    Returns:
  - setLookupSelectedProperties
```
public void setLookupSelectedProperties(List<DisplayPropertyMetaModel> lookupFieldDisplayProperties)
```
  - getComponentTypeHint
```
public String getComponentTypeHint()
```
    When present this gives a hint to the component factories to help with choosing a proper component to select a single record of this type. This is only used when this class is the parent in an UP relation, and the child needs to add a control to help it select one parent.
    
    Specified by:
    
    getComponentTypeHint in interface ClassMetaModel
    
    Returns:
  - setComponentTypeHint
```
public void setComponentTypeHint(String componentTypeHint)
```
  - getPrimaryKey
```
public PropertyMetaModel<?> getPrimaryKey()
```
    Description copied from interface: ClassMetaModel
    
    Returns the property containing the primary key for this object, if one can be found.
    
    Specified by:
    
    getPrimaryKey in interface ClassMetaModel
    
    Returns:
  - setPrimaryKey
```
public void setPrimaryKey(PropertyMetaModel<?> primaryKey)
```
  - getTableName
```
public String getTableName()
```
    Description copied from interface: ClassMetaModel
    
    If this is a persistent class that is directly mapped onto some table, this might return the table name. This should NOT return a name for data that is strictly derived from a metamodel-based database because there all value records share the same table.
    
    Specified by:
    
    getTableName in interface ClassMetaModel
    
    Returns:
  - setTableName
```
public void setTableName(String tableName)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDomainValues
```
public Object[] getDomainValues()
```
    Description copied from interface: ClassMetaModel
    
    If this class is an Enum or represents some enumerated value, this returns the possible value objects. If this is not a domain type this MUST return null.
    
    Specified by:
    
    getDomainValues in interface ClassMetaModel
    
    Returns:
  - setDomainValues
```
public void setDomainValues(Object[] domainValues)
```
  - getClassNameOnly
```
public String getClassNameOnly()
```
  - getDomainLabel
```
@Nullable
public String getDomainLabel(Locale loc,
                                       Object value)
```
    Retrieves a label value for the specified domain value. This is obtained from the appropriate bundle for *this* class. Usually you would use the same call on a property, not on the class, since the property based version allows you to have property-specific translations for values. The property based version delegates here when no property based version is found.
    
    Specified by:
    
    getDomainLabel in interface ClassMetaModel
    
    Returns:
    
    See Also:
    
    ClassMetaModel.getDomainLabel(java.util.Locale, java.lang.Object)
  - getMetaTableDef
```
@Nullable
public ICriteriaTableDef<?> getMetaTableDef()
```
  - setMetaTableDef
```
public void setMetaTableDef(@Nullable
                            ICriteriaTableDef<?> metaTableDef)
```
  - createCriteria
```
@Nonnull
public QCriteria<?> createCriteria()
                                     throws Exception
```
    If this is a persistent class, this should create a base QCriteria instance to do queries on this class. The QCriteria<T> instance returned must have a T that is equal to the value returned by this.getActualClass(). In addition it should have only restrictions that limit the result to valid instances of this class, nothing else! This usually means the restriction set is empty.
    
    Specified by:
    
    createCriteria in interface ClassMetaModel
    
    Returns:
    
    Throws:
    
    Exception
    
    See Also:
    
    ClassMetaModel.createCriteria()
  - getQueryManipulator
```
public IQueryManipulator<?> getQueryManipulator()
```
    Description copied from interface: ClassMetaModel
    
    For Lookup and Combo fields, this can return a QueryManipulator instance that will alter the base query for the list-of-this to show.
    
    Specified by:
    
    getQueryManipulator in interface ClassMetaModel
    
    Returns:
  - setQueryManipulator
```
public void setQueryManipulator(IQueryManipulator<?> queryManipulator)
```
  - getComboSortProperty
```
public String getComboSortProperty()
```
    Description copied from interface: ClassMetaModel
    
    The property name to sort the combobox's presentation on.
    
    Specified by:
    
    getComboSortProperty in interface ClassMetaModel
    
    Returns:
  - setComboSortProperty
```
public void setComboSortProperty(String comboSortProperty)
```

Class DefaultClassMetaModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultClassMetaModel

Method Detail

getClassBundle

getUserEntityName

getUserEntityNamePlural

findProperty

getProperty

findSimpleProperty

getProperties

getComboDataSet

setComboDataSet

getComboLabelRenderer

setComboLabelRenderer

getComboDisplayProperties

setComboDisplayProperties

getComboNodeRenderer

setComboNodeRenderer

getSearchProperties

setSearchProperties

getKeyWordSearchProperties

setKeyWordSearchProperties

getActualClass

getTableDisplayProperties

setTableDisplayProperties

isPersistentClass

setPersistentClass

getDefaultSortProperty

setDefaultSortProperty

getDefaultSortDirection

setDefaultSortDirection

getLookupSelectedRenderer

setLookupSelectedRenderer

getLookupSelectedProperties

setLookupSelectedProperties

getComponentTypeHint

setComponentTypeHint

getPrimaryKey

setPrimaryKey

getTableName

setTableName

toString

getDomainValues

setDomainValues

getClassNameOnly

getDomainLabel

getMetaTableDef

setMetaTableDef

createCriteria

getQueryManipulator

setQueryManipulator

getComboSortProperty

setComboSortProperty