com.edustructures.sifworks.instr
Class Statements

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Statement>
                  com.edustructures.sifworks.instr.Statements

All Implemented Interfaces:

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

public class Statements
extends SIFKeyedList<Statement>

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Statements()
Constructor

Statements(Statement statement)
Constructor that accepts values for all mandatory fields

Method Summary

void	addStatement(java.lang.String value) Adds a new <Statement> 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
Statement	getStatement(java.lang.String value) Gets a Statement object instance.
Statement[]	getStatements() Gets all Statement object instances.
void	removeStatement(java.lang.String value) Removes a Statement object instance.
void	setStatements(Statement[] statements) Sets an array of Statement 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

Statements

public Statements()

Constructor

Statements

public Statements(Statement statement)

Constructor that accepts values for all mandatory fields

Parameters:

statement - The text of the "standard," or "benchmark."

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

addStatement

public void addStatement(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

removeStatement

public void removeStatement(java.lang.String value)

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

Parameters:

value - Identifies the Statement object to remove by its Value value

Since:

1.5r1

getStatement

public Statement getStatement(java.lang.String value)

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

Parameters:

value - Identifies the Statement object to return by its "Value" attribute value

Returns:

A Statement object

Since:

1.5r1

getStatements

public Statement[] getStatements()

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

Returns:

An array of Statement objects

Since:

1.5r1

setStatements

public void setStatements(Statement[] statements)

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

Since:

1.5r1