com.edustructures.sifworks.infra
Class SIF_ColumnHeaders

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SIFColumnHeader>
                  com.edustructures.sifworks.infra.SIF_ColumnHeaders

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<SIFColumnHeader>, java.util.Collection<SIFColumnHeader>

public class SIF_ColumnHeaders
extends SIFKeyedList<SIFColumnHeader>

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_ColumnHeaders()
Constructor

SIF_ColumnHeaders(SIFColumnHeader sifElement)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Element(java.lang.String objectName, java.lang.String value) Adds a new <SIF_Element> repeatable element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
SIFColumnHeader	getSIF_Element(java.lang.String objectName) Gets a SIFColumnHeader object instance.
SIFColumnHeader[]	getSIF_Elements() Gets all SIFColumnHeader object instances.
void	removeSIF_Element(java.lang.String objectName) Removes a SIFColumnHeader object instance.
void	setSIF_Elements(SIFColumnHeader[] sif_elements) Sets an array of SIFColumnHeader objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

SIF_ColumnHeaders

public SIF_ColumnHeaders()

Constructor

SIF_ColumnHeaders

public SIF_ColumnHeaders(SIFColumnHeader sifElement)

Constructor that accepts values for all mandatory fields

Parameters:

sifElement -

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

addSIF_Element

public void addSIF_Element(java.lang.String objectName,
                           java.lang.String value)

Adds a new <SIF_Element> repeatable element. This form of setSIF_Element is provided as a convenience method that is functionally equivalent to the version of setSIF_Element that accepts a single SIFColumnHeader object.

Parameters:

objectName -

value - Gets or sets the content value of the <SIFColumnHeader> element

Since:

2.0

removeSIF_Element

public void removeSIF_Element(java.lang.String objectName)

Removes a SIFColumnHeader object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

objectName - Identifies the SIFColumnHeader object to remove by its ObjectName value

Since:

2.0

getSIF_Element

public SIFColumnHeader getSIF_Element(java.lang.String objectName)

Gets a SIFColumnHeader object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

objectName - Identifies the SIFColumnHeader object to return by its "ObjectName" attribute value

Returns:

A SIFColumnHeader object

Since:

2.0

getSIF_Elements

public SIFColumnHeader[] getSIF_Elements()

Gets all SIFColumnHeader object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of SIFColumnHeader objects

Since:

2.0

setSIF_Elements

public void setSIF_Elements(SIFColumnHeader[] sif_elements)

Sets an array of SIFColumnHeader objects. All existing SIFColumnHeader instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all SIFColumnHeaders.

Since:

2.0