PathPropertyMetaModel (domui :: domui-core 1.1 API)

java.lang.Object
- to.etc.domui.component.meta.impl.PathPropertyMetaModel<T>

All Implemented Interfaces:

PropertyMetaModel<T>, IValueAccessor<T>, IValueTransformer<T>
```
public class PathPropertyMetaModel<T>
extends Object
implements PropertyMetaModel<T>, IValueAccessor<T>
```
This is a proxy for an existing PropertyMetaModel for path-based properties. This overrides the Accessor and replaces it with an accessor which walks the path to the target property. In addition this uses extended rules to determine the default label and stuff for the extended property.

Author:

Frits Jalvingh Created on Dec 29, 2008

Field Summary
- Fields inherited from interface to.etc.domui.component.meta.PropertyMetaModel
  NO_VALIDATORS

Constructor Summary

Constructors
Constructor and Description

PathPropertyMetaModel(String dottedName, PropertyMetaModel<?>[] accessPath)

Constructors
Constructor and Description
`PathPropertyMetaModel(String dottedName, PropertyMetaModel<?>[] accessPath)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<PropertyMetaModel<?>>`	`getAccessPath()`
`Class<T>`	`getActualType()` Returns the actual type of the property's value.
`<A> A`	`getAnnotation(Class<A> annclass)` If the property has some kind of "annotation" (which in here does not need to be a Java annotation, but which can also be some other java class containing data) this returns it.
`List<Object>`	`getAnnotations()` If the property has some kind of "annotations" (which in here does not need to be a Java annotation, but which can also be some other java class containing data) this returns all of them.
`ClassMetaModel`	`getClassModel()` The ClassModel that this property is a property of.
`String[]`	`getColumnNames()` Return the column name(s) for this property if this is a persisted column in a persistent class.
`Class<? extends IComboDataSet<?>>`	`getComboDataSet()` If this should be represented by a combo this can be set to represent the default combo dataset.
`List<DisplayPropertyMetaModel>`	`getComboDisplayProperties()` For a relation, this is the list of properties that should be shown.
`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 this renderer should be used to render the nodes in the combobox.
`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 the type specified by this property.
`PropertyControlFactory`	`getControlFactory()` If a specific control factory is to be used to create controls for this item this returns that factory.
`IConverter<T>`	`getConverter()` Returns the user-specified converter to use when converting this property's value to and from string.
`String`	`getDefaultHint()` Returns the default hint text (which pops up when the mouse is held over the control that inputs this item).
`String`	`getDefaultLabel()` Return any default label (the text to use before the control that inputs this property) for this property.
`int`	`getDisplayLength()` Returns the #chars to be displayed by default for this item.
`String`	`getDomainValueLabel(Locale loc, Object val)` Retrieves the properly localized string representing a domain value in a type which has a fixed set of domain values (like enum or boolean).
`Object[]`	`getDomainValues()` If the type for this property has a fixed set of domain values (like boolean or enum) this contains all possible values for this property.
`Type`	`getGenericActualType()` The abomination that is Java Generics requires a separate dysfunctional type system to represent generic typing, at the few places it is available.
`int`	`getLength()` Return the defined length for the item PROVIDED IT WAS SET - THIS SUFFERS FROM AN UTTER FUCKUP IN THE JPA "STANDARD".
`List<SearchPropertyMetaModel>`	`getLookupFieldKeySearchProperties()` When used in a `LookupInput` field, this fields are used to create the keyword search inputs.
`List<SearchPropertyMetaModel>`	`getLookupFieldSearchProperties()` When used in a `LookupInput` field, this fields are used to create the search inputs.
`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.
`List<DisplayPropertyMetaModel>`	`getLookupTableProperties()` When used in a `LookupInput` field, this fields are used to show the result of a Search in the DataTable.
`String`	`getName()` Returns the name of the property.
`YesNoType`	`getNowrap()`
`NumericPresentation`	`getNumericPresentation()` Used for numeric types, this returns how to present the number and defines the number's class, like a monetary amount.
`int`	`getPrecision()` Return the specified precision of the numeric field.
`IQueryManipulator<T>`	`getQueryManipulator()` For Lookup and Combo fields, this can return a QueryManipulator instance that will alter the base query for the thing to show.
`YesNoType`	`getReadOnly()` Reports whether a property is readonly.
`String`	`getRegexpUserString()` Use the string to use as the pattern indicator in regexp-validator error messages.
`String`	`getRegexpValidator()` Returns the regexp to use to validate input.
`PropertyRelationType`	`getRelationType()` Tells if this property represents some kind of database relation (a "parent" property referring to the master of this child record, or a property representing the list of children).
`int`	`getScale()` For numeric types, this returns any defined scale.
`SortableType`	`getSortable()` Returns whether the property should be sortable when used in a default table, and defines the initial sort direction of the property.
`TemporalPresentationType`	`getTemporal()` If this is defined as some Date type this further defines the domain (date only, date time etc).
`PropertyMetaValidator[]`	`getValidators()` Get all validators to run on this property's input after conversion.
`T`	`getValue(Object in)` Calculate the value to get.
`ClassMetaModel`	`getValueModel()` If applicable, the value type's class model.
`boolean`	`isPrimaryKey()` Returns T if we know this property to be the PK.
`boolean`	`isReadOnly()`
`boolean`	`isRequired()` Whether the property is defined as requiring a value.
`boolean`	`isTransient()` If marked as transient in the persistent class this returns true
`void`	`setValue(Object target, T value)`
`String`	`toString()`

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

- Constructor Detail
  - PathPropertyMetaModel
```
public PathPropertyMetaModel(String dottedName,
                             PropertyMetaModel<?>[] accessPath)
```
- Method Detail
  - toString
```
@Nonnull
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAccessPath
```
@Nonnull
public List<PropertyMetaModel<?>> getAccessPath()
```
  - getValue
```
public T getValue(Object in)
           throws Exception
```
    Calculate the value to get. If any path component is null this returns null, it does not throw exceptions.
    
    Specified by:
    
    getValue in interface IValueTransformer<T>
    
    Throws:
    
    Exception
    
    See Also:
    
    IValueTransformer.getValue(java.lang.Object)
  - setValue
```
public void setValue(Object target,
                     T value)
              throws Exception
```
    Specified by:
    
    setValue in interface IValueAccessor<T>
    
    Throws:
    
    Exception
  - getDefaultHint
```
@Nullable
public String getDefaultHint()
```
    Description copied from interface: PropertyMetaModel
    
    Returns the default hint text (which pops up when the mouse is held over the control that inputs this item). The hint text is a single, short, line of text. Like the default label this gets looked up in the resource file for the class this is a property of. The property that is looked up is 'propertyname.hint'.
    
    Specified by:
    
    getDefaultHint in interface PropertyMetaModel<T>
    
    Returns:
    
    The hint text, or null if not known.
    
    See Also:
    
    PropertyMetaModel.getDefaultHint()
  - getDefaultLabel
```
@Nonnull
public String getDefaultLabel()
```
    Description copied from interface: PropertyMetaModel
    
    Return any default label (the text to use before the control that inputs this property) for this property. The default label is obtained from the resource file with the same location and name as the class file containing the property after doing NLS language replacement; the label text is looked up in that file as 'propertyname.label='. The code uses the "current" locale as set in NlsContext to lookup the proper resource file. If there is no label this returns the property's name.
    
    Specified by:
    
    getDefaultLabel in interface PropertyMetaModel<T>
    
    Returns:
    
    the label text,
    
    See Also:
    
    PropertyMetaModel.getDefaultLabel()
  - getActualType
```
@Nonnull
public Class<T> getActualType()
```
    Description copied from interface: PropertyMetaModel
    
    Returns the actual type of the property's value. This is the return type of the getter function.
    
    Specified by:
    
    getActualType in interface PropertyMetaModel<T>
    
    Returns:
  - getValueModel
```
public ClassMetaModel getValueModel()
```
    Description copied from interface: PropertyMetaModel
    
    If applicable, the value type's class model. Can be asked for explicitly to allow for non-class-based metamodels. It will return null for all primitive and basic types.
    
    Specified by:
    
    getValueModel in interface PropertyMetaModel<T>
    
    Returns:
  - getGenericActualType
```
public Type getGenericActualType()
```
    Description copied from interface: PropertyMetaModel
    
    The abomination that is Java Generics requires a separate dysfunctional type system to represent generic typing, at the few places it is available. This returns the generic type information that is present on whatever type is the return type. This CAN return NULL!!!
    
    Specified by:
    
    getGenericActualType in interface PropertyMetaModel<T>
    
    Returns:
  - getClassModel
```
@Nonnull
public ClassMetaModel getClassModel()
```
    Description copied from interface: PropertyMetaModel
    
    The ClassModel that this property is a property of.
    
    Specified by:
    
    getClassModel in interface PropertyMetaModel<T>
    
    Returns:
  - getComboDataSet
```
public Class<? extends IComboDataSet<?>> getComboDataSet()
```
    Description copied from interface: PropertyMetaModel
    
    If this should be represented by a combo this can be set to represent the default combo dataset. FIXME Must become instance, not class.
    
    Specified by:
    
    getComboDataSet in interface PropertyMetaModel<T>
    
    Returns:
  - getComboDisplayProperties
```
@Nonnull
public List<DisplayPropertyMetaModel> getComboDisplayProperties()
```
    Description copied from interface: PropertyMetaModel
    
    For a relation, this is the list of properties that should be shown. This is needed ONLY when the class metadata of the parent record does not specify a default display column or columnset.
    
    Specified by:
    
    getComboDisplayProperties in interface PropertyMetaModel<T>
    
    Returns:
  - getComboLabelRenderer
```
public Class<? extends ILabelStringRenderer<?>> getComboLabelRenderer()
```
    Description copied from interface: PropertyMetaModel
    
    When this relation-property is presented as a single field this can contain a class to render that field as a string. FIXME Must become instance, not class.
    
    Specified by:
    
    getComboLabelRenderer in interface PropertyMetaModel<T>
    
    Returns:
  - getComboNodeRenderer
```
public Class<? extends INodeContentRenderer<?>> getComboNodeRenderer()
```
    Description copied from interface: PropertyMetaModel
    
    When set this renderer should be used to render the nodes in the combobox. FIXME Must become instance, not class.
    
    Specified by:
    
    getComboNodeRenderer in interface PropertyMetaModel<T>
    
    Returns:
  - getComponentTypeHint
```
public String getComponentTypeHint()
```
    Description copied from interface: PropertyMetaModel
    
    When present this gives a hint to the component factories to help with choosing a proper component to select a single record of the type specified by this property. This is only used when this property points to a parent in an UP relation, and the child needs to add a control to help it select one parent.
    
    Specified by:
    
    getComponentTypeHint in interface PropertyMetaModel<T>
    
    Returns:
  - getConverter
```
public IConverter<T> getConverter()
```
    Description copied from interface: PropertyMetaModel
    
    Returns the user-specified converter to use when converting this property's value to and from string. Can be null.
    
    Specified by:
    
    getConverter in interface PropertyMetaModel<T>
    
    Returns:
  - getDisplayLength
```
public int getDisplayLength()
```
    Description copied from interface: PropertyMetaModel
    
    Returns the #chars to be displayed by default for this item. When present this overrides the length or precision as a size indicator.
    
    Specified by:
    
    getDisplayLength in interface PropertyMetaModel<T>
    
    Returns:
  - getDomainValueLabel
```
public String getDomainValueLabel(Locale loc,
                                  Object val)
```
    Description copied from interface: PropertyMetaModel
    
    Retrieves the properly localized string representing a domain value in a type which has a fixed set of domain values (like enum or boolean). So for instance passing in an english locale and the constant Boolean.TRUE this could return "yes". The translated value is obtained by first looking up a translation in the base class's properties file; if it is undefined there it will be looked up in the enum's property file. If a proper representation cannot be found this will return a toString on the value.
    
    Specified by:
    
    getDomainValueLabel in interface PropertyMetaModel<T>
    
    Returns:
  - getDomainValues
```
public Object[] getDomainValues()
```
    Description copied from interface: PropertyMetaModel
    
    If the type for this property has a fixed set of domain values (like boolean or enum) this contains all possible values for this property. So this will contain the actual enum labels or the constants Boolean.TRUE and Boolean.FALSE. It returns null for other domains.
    
    Specified by:
    
    getDomainValues in interface PropertyMetaModel<T>
    
    Returns:
  - getLength
```
public int getLength()
```
    Description copied from interface: PropertyMetaModel
    
    Return the defined length for the item PROVIDED IT WAS SET - THIS SUFFERS FROM AN UTTER FUCKUP IN THE JPA "STANDARD". This is valid for string-type fields mostly, and should hold the size defined in the database. This field is usually set from the @Column annotation specified. But since that annotation was written by an idiot with a brain the size of a pea the "default" value for the length field in that annotation is set to 255. Since 255 is a valid length value this makes it impossible to determine if the actual length IS 255, or that the user did not provide a value and we need to calculate one ourselves.
    
    Specified by:
    
    getLength in interface PropertyMetaModel<T>
    
    Returns:
    
    The size in characters of this item, or -1 if unknown.
  - getLookupSelectedProperties
```
@Nonnull
public List<DisplayPropertyMetaModel> getLookupSelectedProperties()
```
    Description copied from interface: PropertyMetaModel
    
    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 PropertyMetaModel<T>
    
    Returns:
  - getLookupSelectedRenderer
```
public Class<? extends INodeContentRenderer<?>> getLookupSelectedRenderer()
```
    Description copied from interface: PropertyMetaModel
    
    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 empty this will use the lookupFieldDisplayProperties. FIXME Must become instance, not class.
    
    Specified by:
    
    getLookupSelectedRenderer in interface PropertyMetaModel<T>
    
    Returns:
  - getLookupFieldSearchProperties
```
@Nonnull
public List<SearchPropertyMetaModel> getLookupFieldSearchProperties()
```
    Description copied from interface: PropertyMetaModel
    
    When used in a LookupInput field, this fields are used to create the search inputs.
    
    Specified by:
    
    getLookupFieldSearchProperties in interface PropertyMetaModel<T>
    
    Returns:
  - getLookupFieldKeySearchProperties
```
@Nonnull
public List<SearchPropertyMetaModel> getLookupFieldKeySearchProperties()
```
    Description copied from interface: PropertyMetaModel
    
    When used in a LookupInput field, this fields are used to create the keyword search inputs.
    
    Specified by:
    
    getLookupFieldKeySearchProperties in interface PropertyMetaModel<T>
    
    Returns:
  - getLookupTableProperties
```
@Nonnull
public List<DisplayPropertyMetaModel> getLookupTableProperties()
```
    Description copied from interface: PropertyMetaModel
    
    When used in a LookupInput field, this fields are used to show the result of a Search in the DataTable.
    
    Specified by:
    
    getLookupTableProperties in interface PropertyMetaModel<T>
    
    Returns:
  - getName
```
@Nonnull
public String getName()
```
    Description copied from interface: PropertyMetaModel
    
    Returns the name of the property.
    
    Specified by:
    
    getName in interface PropertyMetaModel<T>
    
    Returns:
  - getPrecision
```
public int getPrecision()
```
    Description copied from interface: PropertyMetaModel
    
    Return the specified precision of the numeric field. Returns -1 if not known or not numeric.
    
    Specified by:
    
    getPrecision in interface PropertyMetaModel<T>
    
    Returns:
    
    the precision, or -1 if unknown. The precision is the total #of digits present in the number, including scale digits.
  - getReadOnly
```
@Nonnull
public YesNoType getReadOnly()
```
    Description copied from interface: PropertyMetaModel
    
    Reports whether a property is readonly. For Java classes a property is defined as readOnly when it has no "setter" method.
    
    Specified by:
    
    getReadOnly in interface PropertyMetaModel<T>
    
    Returns:
  - getRelationType
```
@Nonnull
public PropertyRelationType getRelationType()
```
    Description copied from interface: PropertyMetaModel
    
    Tells if this property represents some kind of database relation (a "parent" property referring to the master of this child record, or a property representing the list of children).
    
    Specified by:
    
    getRelationType in interface PropertyMetaModel<T>
    
    Returns:
  - getNowrap
```
@Nonnull
public YesNoType getNowrap()
```
    Specified by:
    
    getNowrap in interface PropertyMetaModel<T>
  - getScale
```
public int getScale()
```
    Description copied from interface: PropertyMetaModel
    
    For numeric types, this returns any defined scale. If undefined this returns -1.
    
    Specified by:
    
    getScale in interface PropertyMetaModel<T>
    
    Returns:
  - getSortable
```
@Nonnull
public SortableType getSortable()
```
    Description copied from interface: PropertyMetaModel
    
    Returns whether the property should be sortable when used in a default table, and defines the initial sort direction of the property. This defaults to unsortable.
    
    Specified by:
    
    getSortable in interface PropertyMetaModel<T>
    
    Returns:
  - getTemporal
```
@Nonnull
public TemporalPresentationType getTemporal()
```
    Description copied from interface: PropertyMetaModel
    
    If this is defined as some Date type this further defines the domain (date only, date time etc).
    
    Specified by:
    
    getTemporal in interface PropertyMetaModel<T>
    
    Returns:
  - getNumericPresentation
```
@Nonnull
public NumericPresentation getNumericPresentation()
```
    Description copied from interface: PropertyMetaModel
    
    Used for numeric types, this returns how to present the number and defines the number's class, like a monetary amount. This gets overridden when a converter is set!
    
    Specified by:
    
    getNumericPresentation in interface PropertyMetaModel<T>
    
    Returns:
  - getValidators
```
@Nonnull
public PropertyMetaValidator[] getValidators()
```
    Description copied from interface: PropertyMetaModel
    
    Get all validators to run on this property's input after conversion.
    
    Specified by:
    
    getValidators in interface PropertyMetaModel<T>
    
    Returns:
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Description copied from interface: PropertyMetaModel
    
    Returns T if we know this property to be the PK.
    
    Specified by:
    
    isPrimaryKey in interface PropertyMetaModel<T>
    
    Returns:
  - isRequired
```
public boolean isRequired()
```
    Description copied from interface: PropertyMetaModel
    
    Whether the property is defined as requiring a value.
    
    Specified by:
    
    isRequired in interface PropertyMetaModel<T>
    
    Returns:
  - isTransient
```
public boolean isTransient()
```
    Description copied from interface: PropertyMetaModel
    
    If marked as transient in the persistent class this returns true
    
    Specified by:
    
    isTransient in interface PropertyMetaModel<T>
  - getRegexpUserString
```
public String getRegexpUserString()
```
    Description copied from interface: PropertyMetaModel
    
    Use the string to use as the pattern indicator in regexp-validator error messages.
    
    Specified by:
    
    getRegexpUserString in interface PropertyMetaModel<T>
    
    Returns:
  - getRegexpValidator
```
public String getRegexpValidator()
```
    Description copied from interface: PropertyMetaModel
    
    Returns the regexp to use to validate input.
    
    Specified by:
    
    getRegexpValidator in interface PropertyMetaModel<T>
    
    Returns:
  - getControlFactory
```
public PropertyControlFactory getControlFactory()
```
    Description copied from interface: PropertyMetaModel
    
    If a specific control factory is to be used to create controls for this item this returns that factory.
    
    Specified by:
    
    getControlFactory in interface PropertyMetaModel<T>
    
    Returns:
  - getAnnotation
```
public <A> A getAnnotation(@Nonnull
                           Class<A> annclass)
```
    Description copied from interface: PropertyMetaModel
    
    If the property has some kind of "annotation" (which in here does not need to be a Java annotation, but which can also be some other java class containing data) this returns it.
    
    Specified by:
    
    getAnnotation in interface PropertyMetaModel<T>
    
    Returns:
  - getAnnotations
```
@Nonnull
public List<Object> getAnnotations()
```
    Description copied from interface: PropertyMetaModel
    
    If the property has some kind of "annotations" (which in here does not need to be a Java annotation, but which can also be some other java class containing data) this returns all of them.
    
    Specified by:
    
    getAnnotations in interface PropertyMetaModel<T>
    
    Returns:
  - getColumnNames
```
@Nonnull
public String[] getColumnNames()
```
    Description copied from interface: PropertyMetaModel
    
    Return the column name(s) for this property if this is a persisted column in a persistent class.
    
    Specified by:
    
    getColumnNames in interface PropertyMetaModel<T>
  - getQueryManipulator
```
@Nullable
public IQueryManipulator<T> getQueryManipulator()
```
    Description copied from interface: PropertyMetaModel
    
    For Lookup and Combo fields, this can return a QueryManipulator instance that will alter the base query for the thing to show.
    
    Specified by:
    
    getQueryManipulator in interface PropertyMetaModel<T>
    
    Returns:
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    
    isReadOnly in interface IValueAccessor<T>

Class PathPropertyMetaModel<T>

Field Summary

Fields inherited from interface to.etc.domui.component.meta.PropertyMetaModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PathPropertyMetaModel

Method Detail

toString

getAccessPath

getValue

setValue

getDefaultHint

getDefaultLabel

getActualType

getValueModel

getGenericActualType

getClassModel

getComboDataSet

getComboDisplayProperties

getComboLabelRenderer

getComboNodeRenderer

getComponentTypeHint

getConverter

getDisplayLength

getDomainValueLabel

getDomainValues

getLength

getLookupSelectedProperties

getLookupSelectedRenderer

getLookupFieldSearchProperties

getLookupFieldKeySearchProperties

getLookupTableProperties

getName

getPrecision

getReadOnly

getRelationType

getNowrap

getScale

getSortable

getTemporal

getNumericPresentation

getValidators

isPrimaryKey

isRequired

isTransient

getRegexpUserString

getRegexpValidator

getControlFactory

getAnnotation

getAnnotations

getColumnNames

getQueryManipulator

isReadOnly