com.cmobilecom.af.model.property

Class EntityHierarchyProperty<T extends PersistenceEntity>

java.lang.Object

com.cmobilecom.af.model.bean.Component

com.cmobilecom.af.model.property.EntityProperty<T>

com.cmobilecom.af.model.property.EntityHierarchyProperty<T>

Type Parameters:

T - PersistenceEntity, it is entity type, not property type

All Implemented Interfaces:

ClientBehaviorHolder, MenuNodeActionHandler, java.io.Serializable

public class EntityHierarchyProperty<T extends PersistenceEntity>
extends EntityProperty<T>

EntityHierarchyProperty whose value is Hierarchy entity or hierarchy id(String). An hierarchy entity(or id) can also be represented as EntityCategoryProperty that is rendered as multiple levels of selects.

EntityHierarchyProperty, if its value is a hierarchy entity, is auto complete enabled by default.

Since:

4.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.cmobilecom.af.model.property.EntityProperty

backingBean, children, COMMAND_OPEN_INPUT_DIALOG, CSS_ALIGN_CENTER, CSS_ALIGN_LEFT, CSS_ALIGN_RIGHT, CSS_BREAK_WORD, CSS_LONG_TEXT, CSS_PROPERTY_HEADER_PREFIX, CSS_PROPERTY_VALUE_PREFIX, customProperty, NAME_PATH_SEPARATOR_CHAR, parent

Fields inherited from class com.cmobilecom.af.model.bean.Component

parentComponent, uiView

Constructor Summary

Constructors

Constructor and Description
EntityHierarchyProperty(PersistenceDataBackingBean<T> backingBean, java.lang.String name, java.lang.Class type, java.lang.reflect.Method readMethod, java.lang.reflect.Method writeMethod, EntityProperty<T> parent) Constructor.

Method Summary

Modifier and Type	Method and Description
<Q> javax.persistence.criteria.Expression<java.lang.Boolean>	getQueryCriterion(javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.CriteriaQuery<Q> criteriaQuery) Build query restriction from this hierarchy property.
protected java.lang.Object	getValueInternal(T entity, boolean convertToString) Get property value
void	validate(java.lang.Object value) Validate property value including required, length, and value ranges.

Methods inherited from class com.cmobilecom.af.model.property.EntityProperty

addChild, addChild, addChildren, addMenuNode, anyRowHasInvalidUserInput, autoCompleteSuggestions, canBeExecuteTarget, clearInvalidUserInput, clickLink, clickMenuNode, clickValueLink, convert, createDialogContent, getActionPartialBehavior, getActionRenderRegions, getBackingBean, getCheckImageURL, getChild, getChildCount, getChildren, getContainerBean, getContainerRenderRegions, getCurrentEntity, getCustomValue, getDisplayName, getDomEventDynamicHandler, getDomEventDynamicHandler, getDomEventSupport, getDomEventSupport, getEditable, getEmbeddedStatisticsValueString, getEntity, getEntityAttr, getEntityBackingBean, getGroup, getGroupPropertyList, getHelp, getHelpMessage, getInvalidUserInput, getMaxLength, getMaxValue, getMediaURLs, getMenuBean, getMenuBean, getMenuBean, getMenuNode, getMenuNodeCount, getMessage, getMinLength, getMinValue, getName, getNamePath, getNamePath, getOpenInputDialogMenuNode, getParent, getParent, getParentComponent, getPartialBehavior, getPartialBehaviorSupport, getPartialBehaviorSupport, getPath, getPattern, getPlaceholder, getPlaceholderText, getProgressDescriptor, getQueryInfo, getReadMethod, getReadMethod, getRenderStyle, getRoot, getRowIndex, getSelectItems, getSelectPropertyQueryElements, getStatisticsValueString, getStyleClass, getStyleClassByNamePath, getStyleClassByNamePath, getType, getTypeOrMemberType, getValue, getValue, getValueAutoComplete, getValueBoolean, getValueBoolean, getValueChangePartialBehavior, getValueConverter, getValueDate, getValueDate, getValueInt, getValueInt, getValueInternal, getValueList, getValueList, getValueObject, getValueObject, getValueString, getValueString, getValueStringNative, getValueStringNative, getValueToShowOnActionClick, getViewConfig, getVisibleName, getVisibleName, getWriteMethod, handlePartialBehaviorEvent, handlePartialBehaviorEvent, hasInvalidUserInput, isAutoCompleteMultiValues, isCheckAvailabilityEnabled, isChildProperty, isCustomProperty, isDisplayValueOnly, isDynamicPartialBehaviorSupport, isDynamicRenderStyle, isDynamicSelectQuery, isDynamicValue, isEditable, isEditableIfCreating, isEditEnabled, isEntityDefined, isGrouping, isGroupTitleRow, isHelpRenderable, isHidden, isMarkAsRequired, isMenuNodeRenderable, isMessageRenderable, isNameRenderable, isOpenInputDialog, isReadOnly, isRenderable, isRenderAsOutputText, isRequired, isRequiredStarRenderable, isSelected, isShowIfNull, isShowing, isShowing, isShowName, isUserDefined, isValidationDelayed, isValueRenderable, postInit, setBackingBean, setCheckAvailabilityEnabled, setCurrentEntity, setCustomProperty, setCustomValue, setDefaultValueFromSelectItems, setDomEventSupport, setDynamicPartialBehaviorSupport, setDynamicRenderStyle, setDynamicSelectQuery, setDynamicValue, setEditable, setEditableIfCreating, setEditableRecursively, setEditEnabled, setEntityAttr, setGroup, setGrouping, setGroupTitleRow, setHelp, setHidden, setInvalidUserInput, setMarkAsRequired, setMaxLength, setMaxValue, setMessage, setMessage, setMessage, setMinLength, setMinValue, setName, setParent, setPartialBehaviorSupport, setPattern, setPlaceholder, setQueryInfo, setRenderStyle, setRenderStyle, setRequired, setSelected, setSelectPropertyQueryElements, setShowIfNull, setShowName, setStyleClass, setType, setValidationDelayed, setValue, setValue, setValue, setValue, setValueAutoComplete, setValueBoolean, setValueBoolean, setValueConverter, setValueDate, setValueDate, setValueInt, setValueInt, setValueInternal, setValueList, setValueList, setValueObject, setValueString, setValueString, setValueStringNative, setValueStringNative, setVisibleName, setVisibleName, toString

Methods inherited from class com.cmobilecom.af.model.bean.Component

existPathToAncestorType, getChildOfClosestAncestor, getClientId, getClosestAncestor, getComponentsOnPathTo, getPathTo, getRootComponent, getUiView, isAncesterComponentOf, isEntityI18NEnabled, isInPageContent, setClientId, setParentComponent, setUiView

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityHierarchyProperty

public EntityHierarchyProperty(PersistenceDataBackingBean<T> backingBean,
                               java.lang.String name,
                               java.lang.Class type,
                               java.lang.reflect.Method readMethod,
                               java.lang.reflect.Method writeMethod,
                               EntityProperty<T> parent)
                        throws SystemException

Constructor.

Parameters:

backingBean - entity or entity list backing bean

name - property name

type - property type

readMethod - read method

writeMethod - write method

parent - parent property

Throws:

SystemException - throw if an error occurs

Method Detail

validate

public void validate(java.lang.Object value)
              throws InvalidValueException,
                     SystemException

Description copied from class: EntityProperty

Validate property value including required, length, and value ranges.

If validation is delayed, validate() is called by EntityBackingBean.validate() during Invoke Application Phase, and property value has been set during model update phase even though the value is invalid.

Otherwise if validation is not delayed(default), validate() is called before setting property value after data conversion during Model Update phase.

Overrides:

validate in class EntityProperty<T extends PersistenceEntity>

Parameters:

value - property value that has been converted to property type

Throws:

InvalidValueException - throw if the value is invalid

SystemException - throw if any ohter error occurs

getValueInternal

protected java.lang.Object getValueInternal(T entity,
                                            boolean convertToString)
                                     throws SystemException

Description copied from class: EntityProperty

Get property value

Overrides:

getValueInternal in class EntityProperty<T extends PersistenceEntity>

Parameters:

entity - the entity to get value from

convertToString - flag indicating whether the property value should be converted into a string

Returns:

property value

Throws:

SystemException - throw if an error occurs

getQueryCriterion

public <Q> javax.persistence.criteria.Expression<java.lang.Boolean> getQueryCriterion(javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                                                                                      javax.persistence.criteria.CriteriaQuery<Q> criteriaQuery)
                                                                               throws SystemException

Build query restriction from this hierarchy property.

If matchType is START_WITH, match the hierarchy value or its descendants.

Overrides:

getQueryCriterion in class EntityProperty<T extends PersistenceEntity>

Parameters:

criteriaBuilder - the CriteriaBuilder instance

criteriaQuery - the CriteriaQuery being built

Returns:

Predicate instance

Throws:

SystemException - throw if an error occurs