to.etc.domui.component.meta.impl

Class DefaultPropertyMetaModel<T>

java.lang.Object

to.etc.domui.component.meta.impl.BasicPropertyMetaModel<T>

to.etc.domui.component.meta.impl.DefaultPropertyMetaModel<T>

All Implemented Interfaces:

PropertyMetaModel<T>, IValueAccessor<T>, IValueTransformer<T>

public class DefaultPropertyMetaModel<T>
extends BasicPropertyMetaModel<T>
implements PropertyMetaModel<T>

Field Summary

Fields inherited from class to.etc.domui.component.meta.impl.BasicPropertyMetaModel

NO_NAMES

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

NO_VALIDATORS

Constructor Summary

Constructors

Constructor and Description
DefaultPropertyMetaModel(DefaultClassMetaModel classModel, PropertyInfo descriptor)

Method Summary

Modifier and Type	Method and Description
Class<T>	getActualType() Returns the actual type of the property's value.
<A> A	getAnnotation(Class<A> annclass) This basic implementation returns annotations on the "getter" method of the property, if available.
List<Object>	getAnnotations() This basic implementation returns all annotations on the "getter" method of the property, if available.
ClassMetaModel	getClassModel() The ClassModel that this property is a property of.
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.
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.
String	getDomainValueLabel(Locale loc, Object val) Get a property-related translation for a domain value for this property.
Object[]	getDomainValues() FIXME Needs to be filled in by some kind of factory, not in this thingy directly!! For enum and boolean property types this returns the possible values for the domain.
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.
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.
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).
T	getValue(Object in) Retrieve the value from this object.
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()
void	setComboDataSet(Class<? extends IComboDataSet<?>> comboDataSet)
void	setComboDisplayProperties(List<DisplayPropertyMetaModel> displayProperties)
void	setComboLabelRenderer(Class<? extends ILabelStringRenderer<?>> comboLabelRenderer)
void	setComboNodeRenderer(Class<? extends INodeContentRenderer<?>> comboNodeRenderer)
void	setComponentTypeHint(String componentTypeHint)
void	setLength(int length)
void	setLookupFieldKeySearchProperties(List<SearchPropertyMetaModel> lookupFieldKeySearchProperties)
void	setLookupFieldSearchProperties(List<SearchPropertyMetaModel> lookupFieldSearchProperties)
void	setLookupSelectedProperties(List<DisplayPropertyMetaModel> lookupFieldDisplayProperties)
void	setLookupSelectedRenderer(Class<? extends INodeContentRenderer<?>> lookupFieldRenderer)
void	setLookupTableProperties(List<DisplayPropertyMetaModel> lookupFieldTableProperties)
void	setPrimaryKey(boolean primaryKey)
void	setQueryManipulator(IQueryManipulator<T> queryManipulator)
void	setRelationType(PropertyRelationType relationType)
void	setValue(Object target, T value)
String	toString()

Methods inherited from class to.etc.domui.component.meta.impl.BasicPropertyMetaModel

getColumnNames, getControlFactory, getConverter, getDisplayLength, getNowrap, getNumericPresentation, getPrecision, getReadOnly, getRegexpUserString, getRegexpValidator, getScale, getSortable, getTemporal, getValidators, isRequired, isTransient, setColumnNames, setControlFactory, setConverter, setDisplayLength, setNowrap, setNumericPresentation, setPrecision, setReadOnly, setRegexpUserString, setRegexpValidator, setRequired, setScale, setSortable, setTemporal, setTransient, setValidators

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getColumnNames, getControlFactory, getConverter, getDisplayLength, getNowrap, getNumericPresentation, getPrecision, getReadOnly, getRegexpUserString, getRegexpValidator, getScale, getSortable, getTemporal, getValidators, isRequired, isTransient

Constructor Detail

DefaultPropertyMetaModel

public DefaultPropertyMetaModel(@Nonnull
                                DefaultClassMetaModel classModel,
                                PropertyInfo descriptor)

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: PropertyMetaModel

Returns the name of the property.

Specified by:

getName in interface PropertyMetaModel<T>

Returns:

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:

setValue

public void setValue(Object target,
                     T value)
              throws Exception

Specified by:

setValue in interface IValueAccessor<T>

Throws:

Exception

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface IValueAccessor<T>

getValue

public T getValue(Object in)
           throws Exception

Retrieve the value from this object. If the input object is null this throws IllegalStateException.

Specified by:

getValue in interface IValueTransformer<T>

Throws:

Exception

See Also:

IValueTransformer.getValue(java.lang.Object)

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,

getDefaultHint

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.

getDomainValues

public Object[] getDomainValues()

FIXME Needs to be filled in by some kind of factory, not in this thingy directly!! For enum and boolean property types this returns the possible values for the domain. Booleans always return Boolean.TRUE and Boolean.FALSE; enums return all enum values.

Specified by:

getDomainValues in interface PropertyMetaModel<T>

Returns:

getDomainValueLabel

public String getDomainValueLabel(Locale loc,
                                  Object val)

Get a property-related translation for a domain value for this property.

Specified by:

getDomainValueLabel in interface PropertyMetaModel<T>

Returns:

See Also:

PropertyMetaModel.getDomainValueLabel(java.util.Locale, java.lang.Object)

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.

setLength

public void setLength(int length)

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:

setPrimaryKey

public void setPrimaryKey(boolean primaryKey)

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:

setComboDataSet

public void setComboDataSet(Class<? extends IComboDataSet<?>> comboDataSet)

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:

setComboLabelRenderer

public void setComboLabelRenderer(Class<? extends ILabelStringRenderer<?>> comboLabelRenderer)

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:

setComboDisplayProperties

public void setComboDisplayProperties(@Nonnull
                                      List<DisplayPropertyMetaModel> displayProperties)

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:

setRelationType

public void setRelationType(@Nonnull
                            PropertyRelationType relationType)

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:

getComboNodeRenderer

@Nullable
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:

setComboNodeRenderer

public void setComboNodeRenderer(@Nullable
                                 Class<? extends INodeContentRenderer<?>> comboNodeRenderer)

toString

public String toString()

Overrides:

toString in class Object

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 empty this will use the lookupFieldDisplayProperties. FIXME Must become instance, not class.

Specified by:

getLookupSelectedRenderer in interface PropertyMetaModel<T>

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 PropertyMetaModel<T>

Returns:

setLookupSelectedProperties

public void setLookupSelectedProperties(@Nonnull
                                        List<DisplayPropertyMetaModel> lookupFieldDisplayProperties)

getLookupTableProperties

@Nonnull
public List<DisplayPropertyMetaModel> getLookupTableProperties()

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:

setLookupTableProperties

public void setLookupTableProperties(@Nonnull
                                     List<DisplayPropertyMetaModel> lookupFieldTableProperties)

getLookupFieldSearchProperties

@Nonnull
public List<SearchPropertyMetaModel> getLookupFieldSearchProperties()

When used in a LookupInput field, this fields are used to create the search inputs.

Specified by:

getLookupFieldSearchProperties in interface PropertyMetaModel<T>

Returns:

setLookupFieldSearchProperties

public void setLookupFieldSearchProperties(@Nonnull
                                           List<SearchPropertyMetaModel> lookupFieldSearchProperties)

getLookupFieldKeySearchProperties

@Nonnull
public List<SearchPropertyMetaModel> getLookupFieldKeySearchProperties()

When used in a LookupInput field, this fields are used to create the keyword search inputs.

Specified by:

getLookupFieldKeySearchProperties in interface PropertyMetaModel<T>

Returns:

setLookupFieldKeySearchProperties

public void setLookupFieldKeySearchProperties(@Nonnull
                                              List<SearchPropertyMetaModel> lookupFieldKeySearchProperties)

getComponentTypeHint

@Nullable
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 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:

setComponentTypeHint

public void setComponentTypeHint(@Nullable
                                 String componentTypeHint)

getQueryManipulator

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:

setQueryManipulator

public void setQueryManipulator(IQueryManipulator<T> queryManipulator)

getAnnotation

@Nullable
public <A> A getAnnotation(@Nonnull
                                     Class<A> annclass)

This basic implementation returns annotations on the "getter" method of the property, if available.

Specified by:

getAnnotation in interface PropertyMetaModel<T>

Returns:

See Also:

PropertyMetaModel.getAnnotation(java.lang.Class)

getAnnotations

@Nonnull
public List<Object> getAnnotations()

This basic implementation returns all annotations on the "getter" method of the property, if available. It returns the empty list if nothing is found.

Specified by:

getAnnotations in interface PropertyMetaModel<T>

Returns:

See Also:

PropertyMetaModel.getAnnotations()