Package de.hybris.platform.jalo.type

Class ViewAttributeDescriptor

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.type.TypeManagerManaged

de.hybris.platform.jalo.type.Descriptor

de.hybris.platform.jalo.type.AttributeDescriptor

de.hybris.platform.jalo.type.ViewAttributeDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class ViewAttributeDescriptor
extends AttributeDescriptor

This attribute descriptor describes a ViewType. It describes its value type as well as its persistence implementation.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.type.AttributeDescriptor

AttributeDescriptor.AttributeDescriptorImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.type.Descriptor

Descriptor.DescriptorImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.type.TypeManagerManaged

TypeManagerManaged.TypeManagerManagedImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields inherited from class de.hybris.platform.jalo.type.AttributeDescriptor

ALL, ALL_PUBLIC, ATTRIBUTE_HANDLER, DATABASECOLUMN, DECLARING_ENCLOSING_TYPE, DEFAULTVALUE, DEFAULTVALUE_DEFINITIONSTRING, DESCRIPTION, ENCLOSING_TYPE, ENCRYPTED, ENCRYPTED_FLAG, INHERITED, INHERITED_FLAG, INITIAL, INITIAL_FLAG, LOCALIZED, LOCALIZED_FLAG, MODIFIERS, OPTIONAL, OPTIONAL_FLAG, PARTOF, PARTOF_FLAG, PERSISTENCE_CLASS, PERSISTENCETYPE, PRIMITIVE, PRIMITIVE_FLAG, PRIVATE, PRIVATE_FLAG, PROPERTY, PROPERTY_FLAG, PROPOSED_DATABASE_COLUMN, READ, READ_FLAG, READABLE, REMOVABLE, REMOVE, REMOVE_FLAG, SEARCH, SEARCH_FLAG, TIM_IGNORE, TIM_IGNORE_FLAG, UNIQUE, WRITABLE, WRITE, WRITE_FLAG

Fields inherited from class de.hybris.platform.jalo.type.Descriptor

ATTRIBUTETYPE, QUALIFIER

Fields inherited from class de.hybris.platform.jalo.type.TypeManagerManaged

AUTOCREATE, DEPRECATED, EXTENSION_NAME, GENERATE, NAME

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, HJMPTS, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor	Description
ViewAttributeDescriptor()

Method Summary

Modifier and Type	Method	Description
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)	Creator method for generic creation of attribute descriptor.
java.lang.String	getPersistenceQualifier()	If the attribute is backed by a EJB CMP field this method returns the CMP field name.
int	getPosition()
protected java.util.Map	getXMLCustomProperties()	Override to add custom properties to this type's xml definition.
boolean	isParam()
boolean	isProperty()	Tells whether the attribute is realized as property or not.
boolean	isSearchable()	Tells whether a attribute is searchable or not.
void	setInitial(boolean b)	no-op
void	setLocalized(boolean b)	no-op
void	setParam(boolean isParam)
void	setPartOf(boolean b)	no-op
void	setPosition(int pos)
void	setPrivate(boolean b)	no-op
void	setProperty(boolean b)	no-op
void	setReadable(boolean b)	no-op
void	setRemovable(boolean b)	no-op
void	setSearchable(boolean b)	no-op
void	setWritable(boolean b)	no-op

Methods inherited from class de.hybris.platform.jalo.type.AttributeDescriptor

checkDefaultValueAssignability, checkLocalizedChange, checkPartOfChange, checkPropertyChange, checkSearchableChange, checkSelectionOfDescriptor, checkTypeChange, checkTypePermission, checkTypePermission, exportXMLDefinition, exportXMLDefinitionDefaultValue, getAllDescriptions, getAllDescriptions, getAllNames, getAllSubAttributeDescriptors, getAttributeDescriptorImpl, getAttributeHandler, getDatabaseColumn, getDeclaringEnclosingType, getDefaultValue, getDefaultValue, getDefaultValueDefinitionString, getDescription, getDescription, getDontOptimize, getEnclosingType, getIntModifiersFromMap, getModifiers, getName, getNonInitialAttributes, getPersistenceClass, getPersistenceType, getProposedDatabaseColumn, getSelectionOf, getSubAttributeDescriptors, getXMLDefinition, interpretAndReplaceDefaultValue, isEncrypted, isInherited, isInitial, isLocalized, isOptional, isPartOf, isPrimitive, isPrivate, isReadable, isRedeclared, isRemovable, isUnique, isWritable, isWriteable, redeclareAttributeType, removeLocalizedProperty, removeLocalizedPropertyNonRecursively, removeProperty, removePropertyNonRecursively, setAllDescriptions, setAllDescriptions, setAttributeHandler, setAttributeType, setDatabaseColumn, setDefaultValue, setDefaultValue, setDescription, setDescription, setDontOptimize, setEncrypted, setLocalizedProperty, setLocalizedPropertyNonRecursively, setModifiers, setOptional, setPrimitive, setProperty, setPropertyNonRecursively, setSelectionOf, setUnique, toString, toString, writeDefaultValueTagAtomic

Methods inherited from class de.hybris.platform.jalo.type.Descriptor

compareTo, getAttributeType, getAttributeType, getContextAdjustedAttributeType, getDescriptorImpl, getQualifier, getRealAttributeType

Methods inherited from class de.hybris.platform.jalo.type.TypeManagerManaged

getAllNames, getExtensionName, getImpl, getName, isAutocreate, isDeprecated, isGenerate, setAllNames, setAllNames, setAutocreate, setExtensionName, setGenerate, setName, setName

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getImplementation, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, setAllProperties, setAllProperties, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getDefaultAttributeModes, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRelatedItems, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isMarkModifiedDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setRelatedItems, setTransientObject, setUseTA, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewAttributeDescriptor

public ViewAttributeDescriptor()

Method Detail

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Description copied from class: AttributeDescriptor

Creator method for generic creation of attribute descriptor. The following attributes are required:

• AttributeDescriptor.ENCLOSING_TYPE
• Descriptor.QUALIFIER
• Descriptor.ATTRIBUTETYPE

Overrides:

createItem in class AttributeDescriptor

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

getPosition

public int getPosition()

setPosition

public void setPosition(int pos)

isParam

public boolean isParam()

setParam

public void setParam(boolean isParam)

isSearchable

public boolean isSearchable()

Description copied from class: AttributeDescriptor

Tells whether a attribute is searchable or not. Usually this may only be true if the attribute has got persistence informations like AttributeDescriptor.getDatabaseColumn()and AttributeDescriptor.getPersistenceClass().

Overrides:

isSearchable in class AttributeDescriptor

Returns:

true is this view attribute is a param attribute, false otherwise

isProperty

public boolean isProperty()

Description copied from class: AttributeDescriptor

Tells whether the attribute is realized as property or not.

A attribute realized as property may always be accessed via ExtensibleItem.getProperty(String)and ExtensibleItem.setProperty(String, Object)as well as the generic way.

Due to the fact that only ExtensibleItemsubclasses can have properties the enclosing type cannot describe a jalo item which is not.

Overrides:

isProperty in class AttributeDescriptor

See Also:

AttributeDescriptor.setProperty(boolean)

getPersistenceQualifier

public java.lang.String getPersistenceQualifier()

Description copied from class: AttributeDescriptor

If the attribute is backed by a EJB CMP field this method returns the CMP field name. Otherwise null is returned.

Overrides:

getPersistenceQualifier in class AttributeDescriptor

setPrivate

public void setPrivate(boolean b)

no-op

Overrides:

setPrivate in class AttributeDescriptor

Parameters:

b - the new private status

See Also:

AttributeDescriptor.isPrivate()

setProperty

public void setProperty(boolean b)

no-op

Overrides:

setProperty in class AttributeDescriptor

Parameters:

b - the new property flag status

See Also:

AttributeDescriptor.isProperty()

setLocalized

public void setLocalized(boolean b)

no-op

Overrides:

setLocalized in class AttributeDescriptor

Parameters:

b - the new localized status

setWritable

public void setWritable(boolean b)

no-op

Overrides:

setWritable in class AttributeDescriptor

See Also:

AttributeDescriptor.isWritable()

setReadable

public void setReadable(boolean b)

no-op

Overrides:

setReadable in class AttributeDescriptor

See Also:

AttributeDescriptor.isReadable()

setSearchable

public void setSearchable(boolean b)

no-op

Overrides:

setSearchable in class AttributeDescriptor

setPartOf

public void setPartOf(boolean b)

no-op

Overrides:

setPartOf in class AttributeDescriptor

See Also:

AttributeDescriptor.isPartOf()

setInitial

public void setInitial(boolean b)

no-op

Overrides:

setInitial in class AttributeDescriptor

Parameters:

b - the new initial flag

setRemovable

public void setRemovable(boolean b)

no-op

Overrides:

setRemovable in class AttributeDescriptor

See Also:

AttributeDescriptor.isRemovable()

getXMLCustomProperties

protected java.util.Map getXMLCustomProperties()

Description copied from class: AttributeDescriptor

Override to add custom properties to this type's xml definition.

Overrides:

getXMLCustomProperties in class AttributeDescriptor