com.adobe.dct.transfer
Class DataDictionary

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

All Implemented Interfaces:

ILocalizable, java.io.Serializable

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

Data Dictionary - A tree containing the schema structure and the meta data corresponding to the schema. Data Dictionary is a tree of Data Dictionary Elements each representing a node in the schema.

See Also:

Serialized Form

Field Summary

static java.lang.String	DD_ASSOCIATION_CUTPOINT
static java.lang.String	DD_CLASS_NAME
static java.lang.String	DD_FIRST_LEVEL_CUTPOINT
static java.lang.String	DD_HIERARCHY_CUTPOINT
static java.lang.String	SEPARATOR

Constructor Summary

DataDictionary()
Default constructor for defining data dictionary

DataDictionary(java.lang.String name)
Constructor for defining data dictionary

DataDictionary(java.lang.String name, java.lang.String description, java.util.List DDElements)
Constructor for defining data dictionary

Method Summary

java.lang.String	getChecksum()
java.lang.String	getCrxVersion()
java.util.List	getDDElements()
java.lang.String	getDescription()
DataDictionarySubtype	getDictionarySubtype()
DataDictionaryType	getDictionaryType()
java.lang.String	getDisplayName()
java.util.Map	getExtendedProperties()
java.lang.String	getId()
java.lang.String	getLastChangeBy()
java.util.Date	getLastPublishDate()
java.util.Date	getLastUpdateDate()
java.lang.String	getLocalizationPrefix() The prefix that is appended to all the localizable properties of the this object while generating localization keys
java.util.List	getLocalizationResourceInfoList() gets the list containing localization data associated with this object
java.lang.String	getName()
java.util.Map	getReferenceNameToPathMap()
RemotingServiceInfo	getRemotingServiceInfo()
int	getState()
java.lang.String	getVersion()
int	getVersionNum() Deprecated.
void	setChecksum(java.lang.String checksum)
void	setCrxVersion(java.lang.String crxVersion)
void	setDDElements(java.util.List DDElements)
void	setDescription(java.lang.String description)
void	setDictionarySubtype(DataDictionarySubtype dictionarySubtype)
void	setDictionaryType(DataDictionaryType dictionaryType)
void	setDisplayName(java.lang.String displayName)
void	setExtendedProperties(java.util.Map extendedProperties)
void	setId(java.lang.String id)
void	setLastChangeBy(java.lang.String lastChangeBy)
void	setLastPublishDate(java.util.Date lastPublishDate)
void	setLastUpdateDate(java.util.Date lastUpdateDate)
void	setLocalizationPrefix(java.lang.String prefix)
void	setLocalizationResourceInfoList(java.util.List localizationResourceInfoList) Sets the list of LocalizationResourceInfo on this object
void	setName(java.lang.String name)
void	setReferenceNameToPathMap(java.util.Map referenceNameToPathMap)
void	setRemotingServiceInfo(RemotingServiceInfo serviceInfo)
void	setState(int state)
void	setVersion(java.lang.String version)
void	setVersionNum(int versionNum) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR

See Also:

Constant Field Values

DD_CLASS_NAME

public static final java.lang.String DD_CLASS_NAME

DD_ASSOCIATION_CUTPOINT

public static final java.lang.String DD_ASSOCIATION_CUTPOINT

DD_HIERARCHY_CUTPOINT

public static final java.lang.String DD_HIERARCHY_CUTPOINT

DD_FIRST_LEVEL_CUTPOINT

public static final java.lang.String DD_FIRST_LEVEL_CUTPOINT

Constructor Detail

DataDictionary

public DataDictionary()

Default constructor for defining data dictionary

DataDictionary

public DataDictionary(java.lang.String name)

Constructor for defining data dictionary

Parameters:

name - name of the data dictionary. The name of data dictionary is unique in a system.

DataDictionary

public DataDictionary(java.lang.String name,
                      java.lang.String description,
                      java.util.List DDElements)

Constructor for defining data dictionary

Parameters:

name - name of the data dictionary. The name of data dictionary is unique in a system.

description - description of the data dictionary

DDElements - the list of top level data dictionary elements.

Method Detail

getId

public java.lang.String getId()

Returns:

identifier of the data dictionary

setId

public void setId(java.lang.String id)

Parameters:

id - identifier of the data dictionary

getName

public java.lang.String getName()

Returns:

name of the data dictionary. The name of data dictionary is unique in a system.

setName

public void setName(java.lang.String name)

Parameters:

name - name of the data dictionary. The name of data dictionary is unique in a system.

getDisplayName

public java.lang.String getDisplayName()

Returns:

the user friendly name of the data dictionary

setDisplayName

public void setDisplayName(java.lang.String displayName)

Parameters:

displayName - the user friendly name of the data dictionary

getDescription

public java.lang.String getDescription()

Returns:

description of the data dictionary

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - description of the data dictionary

getDDElements

public java.util.List getDDElements()

Returns:

the list of the top level elements in the data dictionary

setDDElements

public void setDDElements(java.util.List DDElements)

Parameters:

DDElements - the list of the top level elements in the data dictionary

getExtendedProperties

public java.util.Map getExtendedProperties()

Returns:

the extended meta data properties of the data dictionary

setExtendedProperties

public void setExtendedProperties(java.util.Map extendedProperties)

Parameters:

extendedProperties - the extended meta data properties of the data dictionary

getDictionaryType

public DataDictionaryType getDictionaryType()

Returns:

the type of the data dictionary

setDictionaryType

public void setDictionaryType(DataDictionaryType dictionaryType)

Parameters:

dictionaryType - the type of the data dictionary

getDictionarySubtype

public DataDictionarySubtype getDictionarySubtype()

Returns:

the dictionarySubtype

setDictionarySubtype

public void setDictionarySubtype(DataDictionarySubtype dictionarySubtype)

Parameters:

dictionarySubtype - the dictionarySubtype to set

getVersion

public java.lang.String getVersion()

Returns:

the version of the data dictionary

setVersion

public void setVersion(java.lang.String version)

Parameters:

version - the version of the data dictionary

getCrxVersion

public java.lang.String getCrxVersion()

Returns:

the crxVersion

setCrxVersion

public void setCrxVersion(java.lang.String crxVersion)

Parameters:

crxVersion - the crxVersion to set

getChecksum

public java.lang.String getChecksum()

Returns:

the checksum generated at the time of data dictionary creation

setChecksum

public void setChecksum(java.lang.String checksum)

Parameters:

checksum - the checksum generated at the time of data dictionary creation

getReferenceNameToPathMap

public java.util.Map getReferenceNameToPathMap()

Returns:

map containing reference name versus path mapping for all Data Dictionary Elements within the Data Dictionary.

setReferenceNameToPathMap

public void setReferenceNameToPathMap(java.util.Map referenceNameToPathMap)

Parameters:

referenceNameToPathMap - map containing reference name versus path mapping for all Data Dictionary Elements within the Data Dictionary.

getRemotingServiceInfo

public RemotingServiceInfo getRemotingServiceInfo()

Returns:

the LCDS Remoting Service info of the data dictionary

setRemotingServiceInfo

public void setRemotingServiceInfo(RemotingServiceInfo serviceInfo)

Parameters:

serviceInfo - LCDS Remoting Service info for the data dictionary

getState

public int getState()

Returns:

the state of the Data Dictionary.

setState

public void setState(int state)

Parameters:

state - the state of the Data Dictionary.

getVersionNum

public int getVersionNum()

Deprecated.

Returns:

the version number of the data dictionary

setVersionNum

public void setVersionNum(int versionNum)

Deprecated.

Parameters:

versionNum - the version number of the data dictionary

getLastUpdateDate

public java.util.Date getLastUpdateDate()

Returns:

the last updated date of the data dictionary

setLastUpdateDate

public void setLastUpdateDate(java.util.Date lastUpdateDate)

Parameters:

lastUpdateDate - the last updated date of the data dictionary

getLastPublishDate

public java.util.Date getLastPublishDate()

Returns:

the last published date of the data dictionary

setLastPublishDate

public void setLastPublishDate(java.util.Date lastPublishDate)

Parameters:

lastPublishDate - the last published date of the data dictionary

getLastChangeBy

public java.lang.String getLastChangeBy()

Returns:

user who last changed the data dictionary

setLastChangeBy

public void setLastChangeBy(java.lang.String lastChangeBy)

Parameters:

lastChangeBy - user who last changed the data dictionary

getLocalizationResourceInfoList

public java.util.List getLocalizationResourceInfoList()

gets the list containing localization data associated with this object

Returns:

list containing LocalizationResourceInfo objects

setLocalizationResourceInfoList

public void setLocalizationResourceInfoList(java.util.List localizationResourceInfoList)

Sets the list of LocalizationResourceInfo on this object

Parameters:

locResourceInfoList - list containing LocalizationResourceInfo objects

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)