com.bigllc.retsiq.metadata
Class MetadataClass

java.lang.Object
  com.bigllc.retsiq.metadata.MetadataTableMap
      com.bigllc.retsiq.metadata.MetadataClass

public class MetadataClass
extends MetadataTableMap

Field Summary

static java.lang.String	CLASS_NAME
static java.lang.String	CLASS_TIME_STAMP
static java.lang.String	COLUMN_GROUP_DATE
static java.lang.String	COLUMN_GROUP_SET_DATE
static java.lang.String	COLUMN_GROUP_SET_VERSION
static java.lang.String	COLUMN_GROUP_VERSION
static java.lang.String	DELETED_FLAG_FIELD
static java.lang.String	DELETED_FLAG_VALUE
static java.lang.String	DESCRIPTION
static java.lang.String	HAS_KEY_INDEX
static java.lang.String	OFFSET_SUPPORT
static java.lang.String	STANDARD_NAME
static java.lang.String	TABLE_DATE
static java.lang.String	TABLE_VERSION
static java.lang.String	UPDATE_DATE
static java.lang.String	UPDATE_VERSION
static java.lang.String	VISIBLE_NAME
static java.lang.String	X_DISPLAY_ORDER

Fields inherited from class com.bigllc.retsiq.metadata.MetadataTableMap

map, nameKey, parent

Constructor Summary

MetadataClass(java.util.Map<java.lang.String,java.lang.String> map)

MetadataClass(java.util.Map<java.lang.String,java.lang.String> map, java.util.List<MetadataTable> fields, java.util.List<MetadataUpdateType> updateTypes, java.util.List<MetadataColumnGroupSet> groupSets, java.util.List<MetadataColumnGroup> groups)

Method Summary

void	addChild(MetadataTableMap child)
void	addGroup(MetadataColumnGroup group)
void	addGroupSet(MetadataColumnGroupSet groupSet)
java.lang.String	getAttributeName()
MetadataTableMap	getChild(com.bigllc.retsiq.api.RETSConstants.MetadataType type, java.lang.String name)
java.lang.String	getChildDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
java.util.List<? extends MetadataTableMap>	getChildren(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
java.util.Map<java.lang.String,? extends MetadataTableMap>	getChildrenLookup(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
com.bigllc.retsiq.api.RETSConstants.MetadataType[]	getChildTypes()
java.lang.String	getChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
java.lang.String	getClassTimeStamp() The SystemName of the field in the METADATATABLE that acts as the last-change timestamp for this class.
java.lang.String	getColumnGroupDate()
java.lang.String	getColumnGroupSetDate()
java.lang.String	getColumnGroupSetVersion()
java.lang.String	getColumnGroupVersion()
java.lang.String	getDeletedFlagField() The SystemName of the field in the METADATATABLE that indicates that the record is logically deleted.
java.lang.String	getDeletedFlagValue() The value of the field designated by DeletedFlag- Field indicating that a record has been logically deleted.
java.lang.String	getDescription()
java.util.List<java.lang.String>	getDisplayKeys()
int	getDisplayOrder() Extension for layout.
MetadataTable	getField(java.lang.String systemName)
java.util.Map<java.lang.String,MetadataTable>	getFieldMap()
java.util.List<MetadataTable>	getFields()
MetadataColumnGroup	getGroup(java.lang.String groupName)
java.util.List<MetadataColumnGroup>	getGroups()
MetadataColumnGroupSet	getGroupSet(java.lang.String groupSetName)
java.util.List<MetadataColumnGroupSet>	getGroupSets()
com.bigllc.retsiq.api.RETSConstants.MetadataType	getMetadataType()
java.lang.String	getName()
MetadataColumnGroupSet	getRootGroupSet()
java.util.List<MetadataTable>	getSortedByLongNameFields()
java.util.List<MetadataTable>	getSortedByNameFields()
java.lang.String	getStandardName()
java.lang.String	getTableDate()
java.lang.String	getTableVersion()
java.lang.String	getUpdateDate()
MetadataUpdateType	getUpdateType(java.lang.String updateName)
java.util.List<MetadataUpdateType>	getUpdateTypes()
java.lang.String	getUpdateVersion()
java.lang.String	getVisibleName()
boolean	hasKeyIndex() When true, indicates that the Class supports the retrieval of key data for fields advertised in the Table Metadata as InKeyIndex.
boolean	hasOffsetSupport() When true, indicates that the server will honour the Offset parameter when searching this class.
void	setChildDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type, java.lang.String date)
void	setChildrenList(com.bigllc.retsiq.api.RETSConstants.MetadataType type, java.util.List<? extends MetadataTableMap> children) This method should be implemented to set the underlying list to the one passed.
void	setChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type, java.lang.String version)
void	setFields(java.util.List<MetadataTable> fields)
void	sortGroupSets()

Methods inherited from class com.bigllc.retsiq.metadata.MetadataTableMap

find, get, getDepth, getFullPath, getFullPathName, getKeys, getMap, getNameKey, getParent, getPathStack, getReversePathStack, getRoot, getSystem, hasDuplicateChildren, hasEmptyAttribute, isChildOf, removeChild, removeChild, setChildren, setParent, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

See Also:

Constant Field Values

STANDARD_NAME

public static final java.lang.String STANDARD_NAME

See Also:

Constant Field Values

VISIBLE_NAME

public static final java.lang.String VISIBLE_NAME

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

TABLE_VERSION

public static final java.lang.String TABLE_VERSION

See Also:

Constant Field Values

TABLE_DATE

public static final java.lang.String TABLE_DATE

See Also:

Constant Field Values

UPDATE_VERSION

public static final java.lang.String UPDATE_VERSION

See Also:

Constant Field Values

UPDATE_DATE

public static final java.lang.String UPDATE_DATE

See Also:

Constant Field Values

CLASS_TIME_STAMP

public static final java.lang.String CLASS_TIME_STAMP

See Also:

Constant Field Values

DELETED_FLAG_FIELD

public static final java.lang.String DELETED_FLAG_FIELD

See Also:

Constant Field Values

DELETED_FLAG_VALUE

public static final java.lang.String DELETED_FLAG_VALUE

See Also:

Constant Field Values

HAS_KEY_INDEX

public static final java.lang.String HAS_KEY_INDEX

See Also:

Constant Field Values

OFFSET_SUPPORT

public static final java.lang.String OFFSET_SUPPORT

See Also:

Constant Field Values

X_DISPLAY_ORDER

public static final java.lang.String X_DISPLAY_ORDER

See Also:

Constant Field Values

COLUMN_GROUP_VERSION

public static final java.lang.String COLUMN_GROUP_VERSION

See Also:

Constant Field Values

COLUMN_GROUP_DATE

public static final java.lang.String COLUMN_GROUP_DATE

See Also:

Constant Field Values

COLUMN_GROUP_SET_VERSION

public static final java.lang.String COLUMN_GROUP_SET_VERSION

See Also:

Constant Field Values

COLUMN_GROUP_SET_DATE

public static final java.lang.String COLUMN_GROUP_SET_DATE

See Also:

Constant Field Values

Constructor Detail

MetadataClass

public MetadataClass(java.util.Map<java.lang.String,java.lang.String> map)

MetadataClass

public MetadataClass(java.util.Map<java.lang.String,java.lang.String> map,
                     java.util.List<MetadataTable> fields,
                     java.util.List<MetadataUpdateType> updateTypes,
                     java.util.List<MetadataColumnGroupSet> groupSets,
                     java.util.List<MetadataColumnGroup> groups)

Method Detail

getName

public java.lang.String getName()

Overrides:

getName in class MetadataTableMap

getStandardName

public java.lang.String getStandardName()

getVisibleName

public java.lang.String getVisibleName()

getDescription

public java.lang.String getDescription()

getTableVersion

public java.lang.String getTableVersion()

getTableDate

public java.lang.String getTableDate()

getUpdateVersion

public java.lang.String getUpdateVersion()

getUpdateDate

public java.lang.String getUpdateDate()

getColumnGroupDate

public java.lang.String getColumnGroupDate()

getColumnGroupVersion

public java.lang.String getColumnGroupVersion()

getColumnGroupSetDate

public java.lang.String getColumnGroupSetDate()

getColumnGroupSetVersion

public java.lang.String getColumnGroupSetVersion()

getClassTimeStamp

public java.lang.String getClassTimeStamp()

The SystemName of the field in the METADATATABLE that acts as the last-change timestamp for this class. Since RETS/1.7

getDeletedFlagField

public java.lang.String getDeletedFlagField()

The SystemName of the field in the METADATATABLE that indicates that the record is logically deleted. If this element is specified, then DeletedFlagValue MUST be specified as well. Since RETS/1.7

getDeletedFlagValue

public java.lang.String getDeletedFlagValue()

The value of the field designated by DeletedFlag- Field indicating that a record has been logically deleted. If the type of the field named by Deleted- FlagField is numeric, then this value is converted to a number before comparison. If the type of the field named by DeletedFlagField is character, then the shorter of the two values is padded with blanks and the comparison made for equal length. Since RETS/1.7

hasKeyIndex

public boolean hasKeyIndex()

When true, indicates that the Class supports the retrieval of key data for fields advertised in the Table Metadata as InKeyIndex. Since RETS/1.7.2

hasOffsetSupport

public boolean hasOffsetSupport()

When true, indicates that the server will honour the Offset parameter when searching this class. When false, indicates that the server does not support the Offset functionality for this class. Since RETS/1.8

getDisplayOrder

public int getDisplayOrder()

Extension for layout. Provides the display order if supplied or 0 if not

getFields

public java.util.List<MetadataTable> getFields()

getSortedByLongNameFields

public java.util.List<MetadataTable> getSortedByLongNameFields()

getSortedByNameFields

public java.util.List<MetadataTable> getSortedByNameFields()

setFields

public void setFields(java.util.List<MetadataTable> fields)

getFieldMap

public java.util.Map<java.lang.String,MetadataTable> getFieldMap()

getField

public MetadataTable getField(java.lang.String systemName)

getUpdateTypes

public java.util.List<MetadataUpdateType> getUpdateTypes()

getUpdateType

public MetadataUpdateType getUpdateType(java.lang.String updateName)

getGroupSets

public java.util.List<MetadataColumnGroupSet> getGroupSets()

getGroupSet

public MetadataColumnGroupSet getGroupSet(java.lang.String groupSetName)

addGroupSet

public void addGroupSet(MetadataColumnGroupSet groupSet)

sortGroupSets

public void sortGroupSets()

getGroups

public java.util.List<MetadataColumnGroup> getGroups()

getGroup

public MetadataColumnGroup getGroup(java.lang.String groupName)

addGroup

public void addGroup(MetadataColumnGroup group)

getRootGroupSet

public MetadataColumnGroupSet getRootGroupSet()

getMetadataType

public com.bigllc.retsiq.api.RETSConstants.MetadataType getMetadataType()

Specified by:

getMetadataType in class MetadataTableMap

getAttributeName

public java.lang.String getAttributeName()

Specified by:

getAttributeName in class MetadataTableMap

getChildDate

public java.lang.String getChildDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type)

Specified by:

getChildDate in class MetadataTableMap

getChildVersion

public java.lang.String getChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type)

Specified by:

getChildVersion in class MetadataTableMap

setChildDate

public void setChildDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type,
                         java.lang.String date)

Specified by:

setChildDate in class MetadataTableMap

setChildVersion

public void setChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type,
                            java.lang.String version)

Specified by:

setChildVersion in class MetadataTableMap

getChildren

public java.util.List<? extends MetadataTableMap> getChildren(com.bigllc.retsiq.api.RETSConstants.MetadataType type)

Specified by:

getChildren in class MetadataTableMap

setChildrenList

public void setChildrenList(com.bigllc.retsiq.api.RETSConstants.MetadataType type,
                            java.util.List<? extends MetadataTableMap> children)

Description copied from class: MetadataTableMap

This method should be implemented to set the underlying list to the one passed. It is called from setChildren. Lookups are and setParent are handled by setChildren.

Specified by:

setChildrenList in class MetadataTableMap

Parameters:

type - the metadata type of the list

children - the list containing the children nodes.

getChildrenLookup

public java.util.Map<java.lang.String,? extends MetadataTableMap> getChildrenLookup(com.bigllc.retsiq.api.RETSConstants.MetadataType type)

Specified by:

getChildrenLookup in class MetadataTableMap

getChild

public MetadataTableMap getChild(com.bigllc.retsiq.api.RETSConstants.MetadataType type,
                                 java.lang.String name)

Overrides:

getChild in class MetadataTableMap

addChild

public void addChild(MetadataTableMap child)

Overrides:

addChild in class MetadataTableMap

getDisplayKeys

public java.util.List<java.lang.String> getDisplayKeys()

Overrides:

getDisplayKeys in class MetadataTableMap

getChildTypes

public com.bigllc.retsiq.api.RETSConstants.MetadataType[] getChildTypes()

Overrides:

getChildTypes in class MetadataTableMap