com.edustructures.sifworks.dw
Class AggregateStatisticFact

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.dw.AggregateStatisticFact

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AggregateStatisticFact
extends SIFDataObject

This object is the actual value of the measurement. It is always associated with one statistic and one or more characteristics. SIF_Events are reported.

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

AggregateStatisticFact()
Constructor

AggregateStatisticFact(java.lang.String refId, AggregateCharacteristicInfoRefId characteristics, java.lang.String aggregateStatisticInfoRefId, java.math.BigDecimal value)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getAggregateStatisticInfoRefId() Gets the value of the <AggregateStatisticInfoRefId> element.
Characteristics	getCharacteristics() Gets the value of the <Characteristics> element.
java.lang.String	getExcluded() Gets the value of the <Excluded> 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
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.math.BigDecimal	getValue() Gets the value of the <Value> element.
void	removeCharacteristics() Removes the Characteristics child element previously created by calling setCharacteristics
void	setAggregateStatisticInfoRefId(java.lang.String value) Sets the value of the <AggregateStatisticInfoRefId> element.
void	setCharacteristics(AggregateCharacteristicInfoRefId aggregateCharacteristicInfoRefId) Sets the value of the <Characteristics> child element.
void	setCharacteristics(Characteristics value) Sets the value of the <Characteristics> element.
void	setExcluded(java.lang.String value) Sets the value of the <Excluded> element as a String.
void	setExcluded(YesNo value) Sets the value of the <Excluded> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setValue(java.math.BigDecimal value) Sets the value of the <Value> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

Constructor Detail

AggregateStatisticFact

public AggregateStatisticFact()

Constructor

AggregateStatisticFact

public AggregateStatisticFact(java.lang.String refId,
                              AggregateCharacteristicInfoRefId characteristics,
                              java.lang.String aggregateStatisticInfoRefId,
                              java.math.BigDecimal value)

Constructor that accepts values for all mandatory fields

Parameters:

refId -

characteristics - Reference to one or more AggregateCharacteristicInfo objects.

aggregateStatisticInfoRefId -

value - Value of the fact.

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

Parameters:

value - A String object

Since:

1.5r1

setCharacteristics

public void setCharacteristics(Characteristics value)

Sets the value of the <Characteristics> element.

The SIF specification defines the meaning of this element as: "Reference to one or more AggregateCharacteristicInfo objects."

Parameters:

value - A Characteristics object

Since:

1.5r1

setCharacteristics

public void setCharacteristics(AggregateCharacteristicInfoRefId aggregateCharacteristicInfoRefId)

Sets the value of the <Characteristics> child element. This form of setCharacteristics is provided as a convenience method that is functionally equivalent to the version of setCharacteristics that accepts a single Characteristics object.

Parameters:

aggregateCharacteristicInfoRefId - Reference to an AggregateCharacteristicInfo object.

Since:

1.5r1

getCharacteristics

public Characteristics getCharacteristics()

Gets the value of the <Characteristics> element.

The SIF specification defines the meaning of this element as: "Reference to one or more AggregateCharacteristicInfo objects."

Returns:

A Characteristics object

Since:

1.5r1

removeCharacteristics

public void removeCharacteristics()

Removes the Characteristics child element previously created by calling setCharacteristics

Since:

1.5r1

getAggregateStatisticInfoRefId

public java.lang.String getAggregateStatisticInfoRefId()

Gets the value of the <AggregateStatisticInfoRefId> element. This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"Statistic"
SIF2.0	"AggregateStatisticInfoRefId"

Returns:

The AggregateStatisticInfoRefId element of this object.

Since:

1.5r1

setAggregateStatisticInfoRefId

public void setAggregateStatisticInfoRefId(java.lang.String value)

Sets the value of the <AggregateStatisticInfoRefId> element. This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"Statistic"
SIF2.0	"AggregateStatisticInfoRefId"

Parameters:

value - A String object

Since:

1.5r1

getExcluded

public java.lang.String getExcluded()

Gets the value of the <Excluded> element.

Returns:

The Excluded element of this object.

Since:

1.5r1

setExcluded

public void setExcluded(YesNo value)

Sets the value of the <Excluded> element.

Parameters:

value - A constant defined by the YesNo class

Since:

1.5r1

setExcluded

public void setExcluded(java.lang.String value)

Sets the value of the <Excluded> element as a String.

Parameters:

value - The value as a String

Since:

1.5r1

getValue

public java.math.BigDecimal getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Value of the fact."

Returns:

The Value element of this object.

Since:

1.5r1

setValue

public void setValue(java.math.BigDecimal value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Value of the fact."

Parameters:

value - A BigDecimal object

Since:

1.5r1