de.hybris.bootstrap.typesystem

Class YAttributeDescriptor

java.lang.Object

de.hybris.bootstrap.typesystem.YNameSpaceElement

de.hybris.bootstrap.typesystem.YTypeSystemElement

de.hybris.bootstrap.typesystem.YDescriptor

de.hybris.bootstrap.typesystem.YAttributeDescriptor

public class YAttributeDescriptor
extends YDescriptor

Property Summary

Type	Property and Description
boolean	is Gets the value of the property property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YAttributeDescriptor.PersistenceType

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENCRYPTED_FLAG
static int	INHERITED_FLAG
static int	INITIAL_FLAG
static int	LOCALIZED_FLAG
static int	OPTIONAL_FLAG
static int	PARTOF_FLAG
static int	PRIMITIVE_FLAG
static int	PRIVATE_FLAG
static int	PROPERTY_FLAG
static int	READ_FLAG
static int	REMOVE_FLAG
static int	SEARCH_FLAG
static int	TIM_IGNORE_FLAG
static int	WRITE_FLAG

Constructor Summary

Constructors

Constructor and Description
YAttributeDescriptor(String enclosingType, YAttributeDescriptor inheritedFrom)
YAttributeDescriptor(YNamespace container, String enclosingTypeCode, String qualifier, String typeCode)

Method Summary

Modifier and Type	Method and Description
void	addDbColumnDefinitions(Map<String,String> dbColumnDefinitions)
protected void	clearPersistenceInfos()
protected void	connectToRelationEnd(YRelationEnd end)
YAttributeDeployment	getAttributeDeploymentOrFail()
String	getAttributeHandlerIncludingSuperTypes()
String	getColumnName(DatabaseSettings databaseSettings)
YAtomicType	getColumnType()
protected YAtomicType	getColumnType(YType type)
String	getConditionQuery()
String	getConfiguredAttributeHandler()
int	getConfiguredModifiers()
Map<String,String>	getCustomProps() Overwritten to merge all super type properties.
Map<String,String>	getDbColumnDefinitions()
YAttributeDescriptor	getDeclaringAttribute()
YComposedType	getDeclaringType()
protected String	getDefaultMetaTypeCode()
String	getDefaultValueDefinition()
String	getDescription()
String	getDynamicAttributeHandler()
YComposedType	getEnclosingType()
String	getEnclosingTypeCode()
List<ModelTagListener.ModelDataMethod>	getGetters()
YComposedType	getMetaType()
int	getModifiers()
Map<String,String>	getOwnCustomProps()
String	getPersistenceQualifier()
YAttributeDescriptor.PersistenceType	getPersistenceType()
String	getRealColumnName()
YRelationEnd	getRelationEnd()
YAttributeDescriptor	getSelectionOf()
String	getSelectionOfQualifier()
List<ModelTagListener.ModelDataMethod>	getSetters()
YAttributeDescriptor	getSuperAttribute()
boolean	hasFixedColumnName()
boolean	hasNonGenericPersistenceQualifier()
boolean	isBooleanAttribute()
boolean	isDeclared()
boolean	isEncrypted()
boolean	isGenerateInModel()
boolean	isInherited()
boolean	isInitial()
boolean	isLocalized()
boolean	isOptional()
boolean	isPartOf()
boolean	isPersistable()
boolean	isPrimitive()
boolean	isPrivate()
boolean	isProperty() Gets the value of the property property.
boolean	isReadable()
boolean	isRedeclared()
boolean	isRedeclaredOneToManyRelationEnd()
protected boolean	isRelationAttribute()
boolean	isRelationEndAttribute()
boolean	isSearchable()
boolean	isUniqueModifier()
boolean	isWritable()
protected void	redeclare(String typeCode)
protected void	redeclare(String typeCode, int modifiers)
void	resetCaches() Since most typesystem elements use lazy references e.g.
void	setAttributeHandler(String attributeHandler)
void	setConfiguredPersistenceType(YAttributeDescriptor.PersistenceType configuredPersistenceType)
void	setDefaultValueDefinition(String defaultValueDefinition)
void	setDescription(String description)
void	setInherited(boolean isInherited)
void	setModelData(ModelTagListener.ModelData modelData)
void	setPersistenceQualifier(String persistenceQualifier)
void	setPersistenceType(YAttributeDescriptor.PersistenceType persistenceType)
void	setRealColumnName(String configuredColumnName)
void	setRedeclared(boolean isRedeclared)
void	setSelectionOfQualifier(String selectionOfQualifier)
String	toString()
YAttributeDeployment	tryGetAttributeDeployment()
void	validate() Validates the element.

Methods inherited from class de.hybris.bootstrap.typesystem.YDescriptor

getQualifier, getType, getTypeCode, setModifiers, setUniqueModifier

Methods inherited from class de.hybris.bootstrap.typesystem.YTypeSystemElement

addCustomProperties, addCustomProperty, getMetaTypeCode, isAutocreate, isGenerate, setAutocreate, setGenerate, setMetaTypeCode

Methods inherited from class de.hybris.bootstrap.typesystem.YNameSpaceElement

getLoaderInfo, getNamespace, getTypeSystem, setLoaderInfo

Methods inherited from class java.lang.Object

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

Property Detail

is

public boolean isProperty

Gets the value of the property property.

Field Detail

READ_FLAG

public static final int READ_FLAG

See Also:

Constant Field Values

WRITE_FLAG

public static final int WRITE_FLAG

See Also:

Constant Field Values

REMOVE_FLAG

public static final int REMOVE_FLAG

See Also:

Constant Field Values

OPTIONAL_FLAG

public static final int OPTIONAL_FLAG

See Also:

Constant Field Values

SEARCH_FLAG

public static final int SEARCH_FLAG

See Also:

Constant Field Values

PARTOF_FLAG

public static final int PARTOF_FLAG

See Also:

Constant Field Values

PRIVATE_FLAG

public static final int PRIVATE_FLAG

See Also:

Constant Field Values

PROPERTY_FLAG

public static final int PROPERTY_FLAG

See Also:

Constant Field Values

LOCALIZED_FLAG

public static final int LOCALIZED_FLAG

See Also:

Constant Field Values

INHERITED_FLAG

public static final int INHERITED_FLAG

See Also:

Constant Field Values

INITIAL_FLAG

public static final int INITIAL_FLAG

See Also:

Constant Field Values

TIM_IGNORE_FLAG

public static final int TIM_IGNORE_FLAG

See Also:

Constant Field Values

ENCRYPTED_FLAG

public static final int ENCRYPTED_FLAG

See Also:

Constant Field Values

PRIMITIVE_FLAG

public static final int PRIMITIVE_FLAG

See Also:

Constant Field Values

Constructor Detail

YAttributeDescriptor

public YAttributeDescriptor(YNamespace container,
                            String enclosingTypeCode,
                            String qualifier,
                            String typeCode)

YAttributeDescriptor

public YAttributeDescriptor(String enclosingType,
                            YAttributeDescriptor inheritedFrom)

Method Detail

isRedeclaredOneToManyRelationEnd

public boolean isRedeclaredOneToManyRelationEnd()

resetCaches

public void resetCaches()

Description copied from class: YNameSpaceElement

Since most typesystem elements use lazy references e.g. by codes this method allows to reset all lazy loaded references and data so that they will be calculated anew upon next access.

Overrides:

resetCaches in class YDescriptor

redeclare

protected void redeclare(String typeCode)

Overrides:

redeclare in class YDescriptor

redeclare

protected void redeclare(String typeCode,
                         int modifiers)

Overrides:

redeclare in class YDescriptor

getCustomProps

public Map<String,String> getCustomProps()

Overwritten to merge all super type properties. Use getOwnCustomProps() to get just the ones declared at this type.

Overrides:

getCustomProps in class YTypeSystemElement

getOwnCustomProps

public Map<String,String> getOwnCustomProps()

toString

public String toString()

Overrides:

toString in class YDescriptor

connectToRelationEnd

protected void connectToRelationEnd(YRelationEnd end)

getRelationEnd

public YRelationEnd getRelationEnd()

getConditionQuery

public String getConditionQuery()

isRelationEndAttribute

public boolean isRelationEndAttribute()

getDefaultMetaTypeCode

protected String getDefaultMetaTypeCode()

Specified by:

getDefaultMetaTypeCode in class YTypeSystemElement

getMetaType

public YComposedType getMetaType()

Overrides:

getMetaType in class YTypeSystemElement

validate

public void validate()

Description copied from class: YNameSpaceElement

Validates the element. This should check whether or not lazy references can be resolved or any data is missing.

Overrides:

validate in class YDescriptor

isDeclared

public boolean isDeclared()

isInherited

public boolean isInherited()

getPersistenceQualifier

public String getPersistenceQualifier()

hasNonGenericPersistenceQualifier

public boolean hasNonGenericPersistenceQualifier()

setPersistenceQualifier

public void setPersistenceQualifier(String persistenceQualifier)

getPersistenceType

public YAttributeDescriptor.PersistenceType getPersistenceType()

isPersistable

public boolean isPersistable()

getColumnType

public YAtomicType getColumnType()

getColumnType

protected YAtomicType getColumnType(YType type)

getAttributeDeploymentOrFail

public YAttributeDeployment getAttributeDeploymentOrFail()

tryGetAttributeDeployment

public YAttributeDeployment tryGetAttributeDeployment()

isRelationAttribute

protected boolean isRelationAttribute()

getConfiguredModifiers

public int getConfiguredModifiers()

getModifiers

public int getModifiers()

Overrides:

getModifiers in class YDescriptor

isLocalized

public boolean isLocalized()

setPersistenceType

public void setPersistenceType(YAttributeDescriptor.PersistenceType persistenceType)

getSelectionOfQualifier

public String getSelectionOfQualifier()

getSelectionOf

public YAttributeDescriptor getSelectionOf()

setSelectionOfQualifier

public void setSelectionOfQualifier(String selectionOfQualifier)

getEnclosingTypeCode

public String getEnclosingTypeCode()

isRedeclared

public boolean isRedeclared()

clearPersistenceInfos

protected void clearPersistenceInfos()

setInherited

public void setInherited(boolean isInherited)

setRedeclared

public void setRedeclared(boolean isRedeclared)

setModelData

public void setModelData(ModelTagListener.ModelData modelData)

isGenerateInModel

public boolean isGenerateInModel()

getDeclaringAttribute

public YAttributeDescriptor getDeclaringAttribute()

getDeclaringType

public YComposedType getDeclaringType()

getSuperAttribute

public YAttributeDescriptor getSuperAttribute()

getEnclosingType

public YComposedType getEnclosingType()

getDefaultValueDefinition

public String getDefaultValueDefinition()

setDefaultValueDefinition

public void setDefaultValueDefinition(String defaultValueDefinition)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getDbColumnDefinitions

public Map<String,String> getDbColumnDefinitions()

addDbColumnDefinitions

public void addDbColumnDefinitions(Map<String,String> dbColumnDefinitions)

getRealColumnName

public String getRealColumnName()

Returns:

the configuredColumnName

setRealColumnName

public void setRealColumnName(String configuredColumnName)

Parameters:

configuredColumnName - the configuredColumnName to set

isOptional

public boolean isOptional()

isSearchable

public boolean isSearchable()

isPartOf

public boolean isPartOf()

isWritable

public boolean isWritable()

isInitial

public boolean isInitial()

isReadable

public boolean isReadable()

isPrivate

public boolean isPrivate()

isProperty

public boolean isProperty()

Gets the value of the property property.

isEncrypted

public boolean isEncrypted()

isPrimitive

public boolean isPrimitive()

isBooleanAttribute

public boolean isBooleanAttribute()

getSetters

public List<ModelTagListener.ModelDataMethod> getSetters()

getGetters

public List<ModelTagListener.ModelDataMethod> getGetters()

setAttributeHandler

public void setAttributeHandler(String attributeHandler)

getAttributeHandlerIncludingSuperTypes

public String getAttributeHandlerIncludingSuperTypes()

getConfiguredAttributeHandler

public String getConfiguredAttributeHandler()

isUniqueModifier

public boolean isUniqueModifier()

Overrides:

isUniqueModifier in class YDescriptor

setConfiguredPersistenceType

public void setConfiguredPersistenceType(YAttributeDescriptor.PersistenceType configuredPersistenceType)

getDynamicAttributeHandler

public String getDynamicAttributeHandler()

getColumnName

public String getColumnName(DatabaseSettings databaseSettings)

hasFixedColumnName

public boolean hasFixedColumnName()