com.adobe.dct.transfer
Class DataDictionaryElement

java.lang.Object
  com.adobe.dct.transfer.DataDictionaryElement

All Implemented Interfaces:

ILocalizable, java.io.Serializable

public class DataDictionaryElement
extends java.lang.Object
implements java.io.Serializable, ILocalizable

Data Dictionary Element - Elements of Data Dictionary. It is the Domain Model View of a data field

See Also:

Serialized Form

Constructor Summary

DataDictionaryElement()
Default constructor for defining Data Dictionary Element

Method Summary

BindingElement	getBinding()
java.util.List	getChildElements()
DataDictionaryElement	getCollectionElement()
java.lang.String	getCompositeType()
java.lang.String	getDescription()
java.lang.String	getDisplayName()
DataDictionaryElementSubType	getElementSubType()
DataDictionaryElementType	getElementType()
java.lang.String	getExpression()
java.util.Map	getExtendedProperties()
java.lang.String	getId()
java.lang.String	getLcdsDestination()
java.lang.String	getLocalizationPrefix() The prefix that is appended to all the localizable properties of the this object while generating localization keys
java.lang.String	getName()
java.lang.String	getPath()
java.lang.String	getReferenceName()
java.util.Set	getValueSet()
BindingElement	getXMLBinding() Deprecated.
boolean	isComputed()
boolean	isKeyElement()
boolean	isRequired()
void	setBinding(BindingElement binding)
void	setChildElements(java.util.List childElements)
void	setCollectionElement(DataDictionaryElement collectionElement)
void	setCompositeType(java.lang.String compositeType)
void	setComputed(boolean computed)
void	setDescription(java.lang.String description)
void	setDisplayName(java.lang.String displayName)
void	setElementSubType(DataDictionaryElementSubType elementSubType)
void	setElementType(DataDictionaryElementType elementType)
void	setExpression(java.lang.String expression)
void	setExtendedProperties(java.util.Map extendedProperties)
void	setId(java.lang.String id)
void	setKeyElement(boolean keyElement)
void	setLcdsDestination(java.lang.String lcdsDestination)
void	setLocalizationPrefix(java.lang.String prefix)
void	setName(java.lang.String name)
void	setPath(java.lang.String path)
void	setReferenceName(java.lang.String referenceName)
void	setRequired(boolean required)
void	setValueSet(java.util.Set valueSet)
void	setXMLBinding(BindingElement binding) Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataDictionaryElement

public DataDictionaryElement()

Default constructor for defining Data Dictionary Element

Method Detail

getPath

public java.lang.String getPath()

Returns:

the path - unique identifier of every node in the data dictionary tree

setPath

public void setPath(java.lang.String path)

Parameters:

path - the path - unique identifier of every node in the data dictionary tree

getExpression

public java.lang.String getExpression()

Returns:

the expression associated with a computed data dictionary element

setExpression

public void setExpression(java.lang.String expression)

Parameters:

expression - the expression to set for the computed data dictionary element

getXMLBinding

@Deprecated
public BindingElement getXMLBinding()

Deprecated.

Returns:

the binding of the element in the xml schema

setXMLBinding

@Deprecated
public void setXMLBinding(BindingElement binding)

Deprecated.

Parameters:

binding - the binding of the element in the xml schema

getId

public java.lang.String getId()

Returns:

the identifier in the persistent store

setId

public void setId(java.lang.String id)

Parameters:

id - the identifier in the persistent store

getName

public java.lang.String getName()

Returns:

the name of the data dictionary element. The name of a node among the siblings at each node of the data dictionary.

setName

public void setName(java.lang.String name)

Parameters:

name - the name of the data dictionary element. The name of a node among the siblings at each node of the data dictionary.

getDisplayName

public java.lang.String getDisplayName()

Returns:

the user friendly name of the data dictionary element

setDisplayName

public void setDisplayName(java.lang.String displayName)

Parameters:

displayName - the user friendly name of the data dictionary element

getReferenceName

public java.lang.String getReferenceName()

Returns:

the unique reference name of the data dictionary element

setReferenceName

public void setReferenceName(java.lang.String referenceName)

Parameters:

referenceName - the unique reference name of the data dictionary element

getDescription

public java.lang.String getDescription()

Returns:

the description of the data dictionary element

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description of the data dictionary element

isKeyElement

public boolean isKeyElement()

Returns:

true if the data dictionary element is a key element

isComputed

public boolean isComputed()

Returns:

true if the data dictionary element is a computed element

setComputed

public void setComputed(boolean computed)

Parameters:

computed - the computed element to be set

setKeyElement

public void setKeyElement(boolean keyElement)

Parameters:

keyElement - the key element to be set

isRequired

public boolean isRequired()

Returns:

true if the data dictionary element is a required element

setRequired

public void setRequired(boolean required)

Parameters:

required - the required element to be set

getElementType

public DataDictionaryElementType getElementType()

Returns:

the type of the data dictionary element

setElementType

public void setElementType(DataDictionaryElementType elementType)

Parameters:

elementType - the type of the data dictionary element to be set

getElementSubType

public DataDictionaryElementSubType getElementSubType()

Returns:

the subType of the data dictionary element. The subtype further puts restrictions on values corresponding to the data dictionary element.

setElementSubType

public void setElementSubType(DataDictionaryElementSubType elementSubType)

Parameters:

elementSubType - the subType of the data dictionary element. The subtype further puts restrictions on values corresponding to the data dictionary element.

getCollectionElement

public DataDictionaryElement getCollectionElement()

Returns:

the type node denoting the type of collection for a collection data dictionary element.

setCollectionElement

public void setCollectionElement(DataDictionaryElement collectionElement)

Parameters:

collectionElement - the type node denoting the type of collection for a collection data dictionary element.

getValueSet

public java.util.Set getValueSet()

Returns:

the set of values for a data dictionary element corresponding to an ENUM

setValueSet

public void setValueSet(java.util.Set valueSet)

Parameters:

valueSet - the set of values for a data dictionary element corresponding to an ENUM

getChildElements

public java.util.List getChildElements()

Returns:

the children elements of a data dictionary element

setChildElements

public void setChildElements(java.util.List childElements)

Parameters:

childElements - the children elements of a data dictionary element

getCompositeType

public java.lang.String getCompositeType()

Returns:

the name of the composite type for a COMPOSITE data dictionary element

setCompositeType

public void setCompositeType(java.lang.String compositeType)

Parameters:

compositeType - the name of the composite type for a COMPOSITE data dictionary element

getExtendedProperties

public java.util.Map getExtendedProperties()

Returns:

the extended meta-data properties for a data dictionary element

setExtendedProperties

public void setExtendedProperties(java.util.Map extendedProperties)

Parameters:

extendedProperties - the extended meta-data properties for a data dictionary element

getLcdsDestination

public java.lang.String getLcdsDestination()

Returns:

the lcdsDestination for the corresponding data dictionary element

setLcdsDestination

public void setLcdsDestination(java.lang.String lcdsDestination)

Parameters:

lcdsDestination - the lcdsDestination for the corresponding data dictionary element

getBinding

public BindingElement getBinding()

Returns:

the XML or POJO binding of the element

setBinding

public void setBinding(BindingElement binding)

Parameters:

binding - - the XML or POJO binding of the element

getLocalizationPrefix

public java.lang.String getLocalizationPrefix()

The prefix that is appended to all the localizable properties of the this object while generating localization keys

Specified by:

getLocalizationPrefix in interface ILocalizable

Returns:

prefix

setLocalizationPrefix

public void setLocalizationPrefix(java.lang.String prefix)