com.bigllc.retsiq.metadata
Class MetadataTable

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

public class MetadataTable
extends MetadataTableMap

Nested Class Summary

static class	MetadataTable.DataType
static class	MetadataTable.Interpretation

Field Summary

static java.lang.String	ALIGNMENT
static java.lang.String	DATA_TYPE
static java.lang.String	DB_NAME
static java.lang.String	DEFAULT
static java.lang.String	EDIT_MASK_ID
static java.lang.String	FOREIGN_FIELD
static java.lang.String	FOREIGN_KEY_NAME
static java.lang.String	IN_KEY_INDEX
static java.lang.String	INDEX
static java.lang.String	INTERPRETATION
static java.lang.String	KEY_RETRIEVAL_QUERY
static java.lang.String	KEY_RETRIEVAL_SELECT
static java.lang.String	LONG_NAME
static java.lang.String	LOOKUP_NAME
static java.lang.String	MAX_LENGTH
static java.lang.String	MAX_SELECT
static java.lang.String	MAXIMUM
static java.lang.String	METADATA_ENTRY_ID
static java.lang.String	MINIMUM
static java.lang.String	MOD_TIME_STAMP
static java.lang.String	MOD_TIME_STAMP_NAME
static java.lang.String	PRECISION
static java.lang.String	REQUIRED
static java.lang.String	SEARCH_HELP_ID
static java.lang.String	SEARCHABLE
static java.lang.String	SHORT_NAME
static java.lang.String	STANDARD_NAME
static java.lang.String	SYSTEM_NAME
static java.lang.String	UNIQUE
static java.lang.String	UNITS
static java.lang.String	USE_SEPERATOR

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

map, nameKey, parent

Constructor Summary

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

Method Summary

java.lang.String	getAttributeName()
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)
MetadataTable.DataType	getDataType()
java.lang.String	getDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
java.lang.String	getDbName()
int	getDefault()
java.lang.String	getEditMaskID()
java.lang.String	getForeignField() The SystemName from the child record accessed via the specified foreign key.
java.lang.String	getForeignKeyName() When nonblank, indicates that this field is normally populated via a foreign key.
MetadataTable.Interpretation	getInterpretation()
boolean	getKeyRetrievalQuery() When true, indicates that this field may be included in a query that uses the Key optional argument.
boolean	getKeyRetrievalSelect() When true, indicates that this field may be included in the Select list of a query that uses the Key optional argument.
java.lang.String	getLongName()
MetadataLookup	getLookup()
java.lang.String	getLookupName()
int	getMaximum()
double	getMaximumDecimal()
long	getMaximumLong()
int	getMaxLength()
int	getMaxSelect()
java.lang.String	getMetadataEntryId() A value that never changes as long as the semantic definition of this field remains unchanged.
com.bigllc.retsiq.api.RETSConstants.MetadataType	getMetadataType()
int	getMinimum()
double	getMinimumDecimal()
long	getMinimumLong()
boolean	getModTimeStamp() When true, indicates that changes to this field update the class’s ModTimeStamp field.
int	getPrecision()
java.lang.String	getSearchHelpID()
java.lang.String	getShortName()
java.lang.String	getStandardName()
java.lang.String	getSystemName()
java.lang.String	getVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
boolean	isIndex()
boolean	isInKeyIndex() When true, indicates that this field may be included in the Select argument of a Search to suppress normal Limit behavior.
boolean	isLookupField()
boolean	isUnique()
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.

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

addChild, get, getChild, getChildTypes, getFullPathName, getKeys, getMap, getName, getNameKey, getParent, getRoot, getSystem, removeChild, setChildren, setParent, toString

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_ENTRY_ID

public static final java.lang.String METADATA_ENTRY_ID

See Also:

Constant Field Values

SYSTEM_NAME

public static final java.lang.String SYSTEM_NAME

See Also:

Constant Field Values

STANDARD_NAME

public static final java.lang.String STANDARD_NAME

See Also:

Constant Field Values

LONG_NAME

public static final java.lang.String LONG_NAME

See Also:

Constant Field Values

DB_NAME

public static final java.lang.String DB_NAME

See Also:

Constant Field Values

SHORT_NAME

public static final java.lang.String SHORT_NAME

See Also:

Constant Field Values

MAX_LENGTH

public static final java.lang.String MAX_LENGTH

See Also:

Constant Field Values

DATA_TYPE

public static final java.lang.String DATA_TYPE

See Also:

Constant Field Values

PRECISION

public static final java.lang.String PRECISION

See Also:

Constant Field Values

SEARCHABLE

public static final java.lang.String SEARCHABLE

See Also:

Constant Field Values

INTERPRETATION

public static final java.lang.String INTERPRETATION

See Also:

Constant Field Values

ALIGNMENT

public static final java.lang.String ALIGNMENT

See Also:

Constant Field Values

USE_SEPERATOR

public static final java.lang.String USE_SEPERATOR

See Also:

Constant Field Values

EDIT_MASK_ID

public static final java.lang.String EDIT_MASK_ID

See Also:

Constant Field Values

LOOKUP_NAME

public static final java.lang.String LOOKUP_NAME

See Also:

Constant Field Values

MAX_SELECT

public static final java.lang.String MAX_SELECT

See Also:

Constant Field Values

UNITS

public static final java.lang.String UNITS

See Also:

Constant Field Values

INDEX

public static final java.lang.String INDEX

See Also:

Constant Field Values

MINIMUM

public static final java.lang.String MINIMUM

See Also:

Constant Field Values

MAXIMUM

public static final java.lang.String MAXIMUM

See Also:

Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT

See Also:

Constant Field Values

REQUIRED

public static final java.lang.String REQUIRED

See Also:

Constant Field Values

SEARCH_HELP_ID

public static final java.lang.String SEARCH_HELP_ID

See Also:

Constant Field Values

UNIQUE

public static final java.lang.String UNIQUE

See Also:

Constant Field Values

MOD_TIME_STAMP_NAME

public static final java.lang.String MOD_TIME_STAMP_NAME

See Also:

Constant Field Values

MOD_TIME_STAMP

public static final java.lang.String MOD_TIME_STAMP

See Also:

Constant Field Values

FOREIGN_KEY_NAME

public static final java.lang.String FOREIGN_KEY_NAME

See Also:

Constant Field Values

FOREIGN_FIELD

public static final java.lang.String FOREIGN_FIELD

See Also:

Constant Field Values

KEY_RETRIEVAL_QUERY

public static final java.lang.String KEY_RETRIEVAL_QUERY

See Also:

Constant Field Values

KEY_RETRIEVAL_SELECT

public static final java.lang.String KEY_RETRIEVAL_SELECT

See Also:

Constant Field Values

IN_KEY_INDEX

public static final java.lang.String IN_KEY_INDEX

See Also:

Constant Field Values

Constructor Detail

MetadataTable

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

Method Detail

getMetadataEntryId

public java.lang.String getMetadataEntryId()

A value that never changes as long as the semantic definition of this field remains unchanged. In particular, it should be managed so as to allow the client to detect changes to the SystemName. Since 1.7

getSystemName

public java.lang.String getSystemName()

getStandardName

public java.lang.String getStandardName()

getEditMaskID

public java.lang.String getEditMaskID()

getSearchHelpID

public java.lang.String getSearchHelpID()

getDbName

public java.lang.String getDbName()

isIndex

public boolean isIndex()

isUnique

public boolean isUnique()

getLongName

public java.lang.String getLongName()

getShortName

public java.lang.String getShortName()

getInterpretation

public MetadataTable.Interpretation getInterpretation()

getLookupName

public java.lang.String getLookupName()

getLookup

public MetadataLookup getLookup()

isLookupField

public boolean isLookupField()

getMaxSelect

public int getMaxSelect()

getDataType

public MetadataTable.DataType getDataType()

getMaxLength

public int getMaxLength()

getMinimum

public int getMinimum()

getMaximum

public int getMaximum()

getMinimumLong

public long getMinimumLong()

getMaximumLong

public long getMaximumLong()

getMinimumDecimal

public double getMinimumDecimal()

getMaximumDecimal

public double getMaximumDecimal()

getPrecision

public int getPrecision()

getDefault

public int getDefault()

getModTimeStamp

public boolean getModTimeStamp()

When true, indicates that changes to this field update the class’s ModTimeStamp field. Since RETS/1.7

getForeignKeyName

public java.lang.String getForeignKeyName()

When nonblank, indicates that this field is normally populated via a foreign key. The value is the ForeignKeyID from the METADATA-FOREIGNKEYS table. Since RETS/1.7

getForeignField

public java.lang.String getForeignField()

The SystemName from the child record accessed via the specified foreign key. Since RETS/1.7

getKeyRetrievalQuery

public boolean getKeyRetrievalQuery()

When true, indicates that this field may be included in a query that uses the Key optional argument. Since RETS/1.7 Deprecated RETS/1.7.2

getKeyRetrievalSelect

public boolean getKeyRetrievalSelect()

When true, indicates that this field may be included in the Select list of a query that uses the Key optional argument. Since RETS/1.7 Deprecated RETS/1.7.2

isInKeyIndex

public boolean isInKeyIndex()

When true, indicates that this field may be included in the Select argument of a Search to suppress normal Limit behavior. Since RETS/1.7.2

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

getDate

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

Specified by:

getDate in class MetadataTableMap

getVersion

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

Specified by:

getVersion 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