com.bigllc.retsiq.metadata
Class MetadataObject

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

public class MetadataObject
extends MetadataTableMap

Field Summary

static java.lang.String	DESCRIPTION
static java.lang.String	LOCATION_AVAILABILITY
static java.lang.String	MAX_FILE_SIZE
static java.lang.String	METADATA_ENTRY_ID
static java.lang.String	MIME_TYPE
static java.lang.String	OBJECT_COUNT
static java.lang.String	OBJECT_DATA
static java.lang.String	OBJECT_TIME_STAMP
static java.lang.String	OBJECT_TYPE
static java.lang.String	POST_SUPPORT
static java.lang.String	STANDARD_NAME
static java.lang.String	VISIBLE_NAME

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

map, nameKey, parent

Constructor Summary

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

Method Summary

java.lang.String	getAttributeName()
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)
java.lang.String	getChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
java.lang.String	getDescription()
java.util.List<java.lang.String>	getDisplayKeys()
java.lang.String	getLocationAvailability() When true, indicates that the server will honour the Location=1 parameter at least for some Objects.
int	getMaxFileSize() Indicates that maximum file size (in bytes) that is accepted by the server.
java.lang.String	getMaxFileSizeString() Indicates that maximum file size (in bytes) that is accepted by the server.
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()
java.lang.String	getMIMEType()
java.lang.String	getObjectCount() The SystemName of the field in a METADATATABLE that acts as the count for objects of this type.
java.lang.String	getObjectData() Resource and Class of a table that provides additional data about objects described by this metadata.
MetadataClass	getObjectDataClass() Return the class specified in the object data attribute if available and found.
java.lang.String	getObjectDataClassName() Return the class name if the object data attribute is available.
java.lang.String	getObjectDataResourceId() Return the resource id if the object data attribute is available.
java.lang.String	getObjectTimeStamp() The SystemName of the field in a METADATATABLE that acts as the timestamp for objects of this type.
java.lang.String	getObjectType()
java.lang.String	getPostSupport() A value of 0 means that the PostObject transaction is unavailable for this object type.
java.lang.String	getVisibleName()
boolean	hasLocationAvailability() When true, indicates that the server will honour the Location=1 parameter at least for some Objects.
boolean	hasPostSupport() Is the PostObject transaction available for this object type.
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)

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

addChild, find, get, getChild, getChildTypes, getDepth, getFullPath, getFullPathName, getKeys, getMap, getName, 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

METADATA_ENTRY_ID

public static final java.lang.String METADATA_ENTRY_ID

See Also:

Constant Field Values

OBJECT_TYPE

public static final java.lang.String OBJECT_TYPE

See Also:

Constant Field Values

STANDARD_NAME

public static final java.lang.String STANDARD_NAME

See Also:

Constant Field Values

MIME_TYPE

public static final java.lang.String MIME_TYPE

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

OBJECT_TIME_STAMP

public static final java.lang.String OBJECT_TIME_STAMP

See Also:

Constant Field Values

OBJECT_COUNT

public static final java.lang.String OBJECT_COUNT

See Also:

Constant Field Values

LOCATION_AVAILABILITY

public static final java.lang.String LOCATION_AVAILABILITY

See Also:

Constant Field Values

POST_SUPPORT

public static final java.lang.String POST_SUPPORT

See Also:

Constant Field Values

OBJECT_DATA

public static final java.lang.String OBJECT_DATA

See Also:

Constant Field Values

MAX_FILE_SIZE

public static final java.lang.String MAX_FILE_SIZE

See Also:

Constant Field Values

Constructor Detail

MetadataObject

public MetadataObject(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. Since 1.7

getObjectType

public java.lang.String getObjectType()

getMIMEType

public java.lang.String getMIMEType()

getDescription

public java.lang.String getDescription()

getVisibleName

public java.lang.String getVisibleName()

getObjectTimeStamp

public java.lang.String getObjectTimeStamp()

The SystemName of the field in a METADATATABLE that acts as the timestamp for objects of this type. This SystemName MUST be one that appears in every class that has objects of this type. Since RETS/1.7

getObjectCount

public java.lang.String getObjectCount()

The SystemName of the field in a METADATATABLE that acts as the count for objects of this type. This SystemName MUST be one that appears in every class that has objects of this type. Since RETS/1.7

getPostSupport

public java.lang.String getPostSupport()

A value of 0 means that the PostObject transaction is unavailable for this object type. A value of 1 means that it is supported.

Returns:

is post object supported for this object type.

hasPostSupport

public boolean hasPostSupport()

Is the PostObject transaction available for this object type.

Returns:

is post object supported for this object type.

getLocationAvailability

public java.lang.String getLocationAvailability()

When true, indicates that the server will honour the Location=1 parameter at least for some Objects. When false, indicates that the server does not support the Location=1 functionality. Since RETS/1.8

hasLocationAvailability

public boolean hasLocationAvailability()

When true, indicates that the server will honour the Location=1 parameter at least for some Objects. When false, indicates that the server does not support the Location=1 functionality. Since RETS/1.8

getObjectData

public java.lang.String getObjectData()

Resource and Class of a table that provides additional data about objects described by this metadata. If an object contains no additional data, this field MUST be empty or missing.

getObjectDataResourceId

public java.lang.String getObjectDataResourceId()

Return the resource id if the object data attribute is available.

Returns:

the resource id of the object data.

getObjectDataClassName

public java.lang.String getObjectDataClassName()

Return the class name if the object data attribute is available.

Returns:

the class name of the object data.

getObjectDataClass

public MetadataClass getObjectDataClass()

Return the class specified in the object data attribute if available and found.

Returns:

the metadata class

getMaxFileSizeString

public java.lang.String getMaxFileSizeString()

Indicates that maximum file size (in bytes) that is accepted by the server. The server MAY refuse any objects sent that are greater than this size. The server MAY return an http error code if an object bigger than this is received.

Returns:

the size as a string

getMaxFileSize

public int getMaxFileSize()

Indicates that maximum file size (in bytes) that is accepted by the server. The server MAY refuse any objects sent that are greater than this size. The server MAY return an http error code if an object bigger than this is received.

Returns:

the size as an integer in bytes or -1 if none present

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

getDisplayKeys

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

Overrides:

getDisplayKeys in class MetadataTableMap