com.bigllc.retsiq.metadata
Class MetadataColumnGroupTable

java.lang.Object
  extended by com.bigllc.retsiq.metadata.MetadataTableMap
      extended by com.bigllc.retsiq.metadata.MetadataColumnGroupTable

public class MetadataColumnGroupTable
extends MetadataTableMap


Field Summary
static java.lang.String COLUMN_GROUP_SET_NAME
           
static java.lang.String DISPLAY_HEIGHT
           
static java.lang.String DISPLAY_LENGTH
           
static java.lang.String DISPLAY_ORDER
           
static java.lang.String IMMEDIATE_REFRESH
           
static java.lang.String LONG_NAME
           
static java.lang.String METADATA_ENTRY_ID
           
static java.lang.String SHORT_NAME
           
static java.lang.String SYSTEM_NAME
           
static java.lang.String X_VISIBILITY
           
 
Fields inherited from class com.bigllc.retsiq.metadata.MetadataTableMap
map, nameKey, parent
 
Constructor Summary
MetadataColumnGroupTable(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)
           
 com.bigllc.retsiq.api.RETSConstants.MetadataType[] getChildTypes()
           
 java.lang.String getChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
           
 int getDisplayHeight()
           
 java.util.List<java.lang.String> getDisplayKeys()
           
 int getDisplayLength()
           
 int getDisplayOrder()
           
 MetadataTable getField()
           
 MetadataColumnGroupSet getGroupSet()
           
 java.lang.String getGroupSetName()
           
 java.lang.String getLongName()
           
 java.lang.String getMetadataEntryId()
           
 com.bigllc.retsiq.api.RETSConstants.MetadataType getMetadataType()
           
 java.lang.String getShortName()
           
 java.lang.String getSystemName()
           
 java.lang.String getVisibility()
          Determines whether this field is visible for display, edit or both.
 boolean isBlank()
          A blank entry has an empty column group set name and system name.
 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, 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

SYSTEM_NAME

public static final java.lang.String SYSTEM_NAME
See Also:
Constant Field Values

COLUMN_GROUP_SET_NAME

public static final java.lang.String COLUMN_GROUP_SET_NAME
See Also:
Constant Field Values

LONG_NAME

public static final java.lang.String LONG_NAME
See Also:
Constant Field Values

SHORT_NAME

public static final java.lang.String SHORT_NAME
See Also:
Constant Field Values

DISPLAY_ORDER

public static final java.lang.String DISPLAY_ORDER
See Also:
Constant Field Values

DISPLAY_LENGTH

public static final java.lang.String DISPLAY_LENGTH
See Also:
Constant Field Values

DISPLAY_HEIGHT

public static final java.lang.String DISPLAY_HEIGHT
See Also:
Constant Field Values

IMMEDIATE_REFRESH

public static final java.lang.String IMMEDIATE_REFRESH
See Also:
Constant Field Values

X_VISIBILITY

public static final java.lang.String X_VISIBILITY
See Also:
Constant Field Values
Constructor Detail

MetadataColumnGroupTable

public MetadataColumnGroupTable(java.util.Map<java.lang.String,java.lang.String> map)
Method Detail

getMetadataEntryId

public java.lang.String getMetadataEntryId()

getSystemName

public java.lang.String getSystemName()

getVisibility

public java.lang.String getVisibility()
Determines whether this field is visible for display, edit or both. Valid values are ALL, blank or null for both, DISPLAY for display only and EDIT for edit only.


getDisplayOrder

public int getDisplayOrder()

getDisplayHeight

public int getDisplayHeight()

getDisplayLength

public int getDisplayLength()

getField

public MetadataTable getField()

getGroupSet

public MetadataColumnGroupSet getGroupSet()

getGroupSetName

public java.lang.String getGroupSetName()

getLongName

public java.lang.String getLongName()

getShortName

public java.lang.String getShortName()

isBlank

public boolean isBlank()
A blank entry has an empty column group set name and system name.

Returns:
true if this table's group set name and system name are both empty.

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

getChildTypes

public com.bigllc.retsiq.api.RETSConstants.MetadataType[] getChildTypes()
Overrides:
getChildTypes in class MetadataTableMap