com.edustructures.sifworks.dw
Class AggregateStatisticInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AggregateStatisticInfo
extends SIFDataObject

This object defines the attribute of a group of objects that implicitly or explicitly defines a subset of the group. 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

AggregateStatisticInfo()
Constructor

AggregateStatisticInfo(java.lang.String refId, java.lang.String statisticName)
Constructor that accepts values for all mandatory fields

Method Summary

java.util.Calendar	getApprovalDate() Gets the value of the <ApprovalDate> element.
CalculationRule	getCalculationRule() Gets the value of the <CalculationRule> element.
java.util.Calendar	getDiscontinueDate() Gets the value of the <DiscontinueDate> element.
java.util.Calendar	getEffectiveDate() Gets the value of the <EffectiveDate> element.
ExclusionRules	getExclusionRules() Gets the value of the <ExclusionRules> element.
java.util.Calendar	getExpirationDate() Gets the value of the <ExpirationDate> 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
Location	getLocation() Gets the value of the <Location> element.
java.lang.String	getMeasure() Gets the value of the <Measure> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSource() Gets the value of the <Source> element.
java.lang.String	getStatisticName() Gets the value of the <StatisticName> element.
void	removeCalculationRule() Removes the CalculationRule child element previously created by calling setCalculationRule
void	removeExclusionRules() Removes the ExclusionRules child element previously created by calling setExclusionRules
void	removeLocation() Removes the Location child element previously created by calling setLocation
void	setApprovalDate(java.util.Calendar value) Sets the value of the <ApprovalDate> element.
void	setCalculationRule(CalculationRule value) Sets the value of the <CalculationRule> element.
void	setCalculationRule(CalculationRuleType type, java.lang.String value) Sets the value of the <CalculationRule> child element.
void	setDiscontinueDate(java.util.Calendar value) Sets the value of the <DiscontinueDate> element.
void	setEffectiveDate(java.util.Calendar value) Sets the value of the <EffectiveDate> element.
void	setExclusionRules(ExclusionRules value) Sets the value of the <ExclusionRules> element.
void	setExpirationDate(java.util.Calendar value) Sets the value of the <ExpirationDate> element.
void	setLocation(Location value) Sets the value of the <Location> element.
void	setLocation(LocationType type) Sets the value of the <Location> child element.
void	setMeasure(MeasureType value) Sets the value of the <Measure> element.
void	setMeasure(java.lang.String value) Sets the value of the <Measure> element as a String.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSource(java.lang.String value) Sets the value of the <Source> element.
void	setStatisticName(java.lang.String value) Sets the value of the <StatisticName> 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

AggregateStatisticInfo

public AggregateStatisticInfo()

Constructor

AggregateStatisticInfo

public AggregateStatisticInfo(java.lang.String refId,
                              java.lang.String statisticName)

Constructor that accepts values for all mandatory fields

Parameters:

refId - Key

statisticName - Name of Aggregate Statistic

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.

The SIF specification defines the meaning of this attribute as: "Key"

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.

The SIF specification defines the meaning of this attribute as: "Key"

Parameters:

value - A String object

Since:

1.5r1

getStatisticName

public java.lang.String getStatisticName()

Gets the value of the <StatisticName> element.

The SIF specification defines the meaning of this element as: "Name of Aggregate Statistic"

Returns:

The StatisticName element of this object.

Since:

1.5r1

setStatisticName

public void setStatisticName(java.lang.String value)

Sets the value of the <StatisticName> element.

The SIF specification defines the meaning of this element as: "Name of Aggregate Statistic"

Parameters:

value - A String object

Since:

1.5r1

setCalculationRule

public void setCalculationRule(CalculationRule value)

Sets the value of the <CalculationRule> element.

The SIF specification defines the meaning of this element as: "Rule for calculating the aggregate statistic"

Parameters:

value - A CalculationRule object

Since:

1.5r1

setCalculationRule

public void setCalculationRule(CalculationRuleType type,
                               java.lang.String value)

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

Parameters:

type - Values Description, Formula, URL

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

Since:

1.5r1

getCalculationRule

public CalculationRule getCalculationRule()

Gets the value of the <CalculationRule> element.

The SIF specification defines the meaning of this element as: "Rule for calculating the aggregate statistic"

Returns:

A CalculationRule object

Since:

1.5r1

removeCalculationRule

public void removeCalculationRule()

Removes the CalculationRule child element previously created by calling setCalculationRule

Since:

1.5r1

getApprovalDate

public java.util.Calendar getApprovalDate()

Gets the value of the <ApprovalDate> element.

The SIF specification defines the meaning of this element as: "Date for which the statistic is initially valid"

Returns:

The ApprovalDate element of this object.

Since:

1.5r1

setApprovalDate

public void setApprovalDate(java.util.Calendar value)

Sets the value of the <ApprovalDate> element.

The SIF specification defines the meaning of this element as: "Date for which the statistic is initially valid"

Parameters:

value - A Calendar object

Since:

1.5r1

getExpirationDate

public java.util.Calendar getExpirationDate()

Gets the value of the <ExpirationDate> element.

The SIF specification defines the meaning of this element as: "Date after which the statistic is no longer valid"

Returns:

The ExpirationDate element of this object.

Since:

1.5r1

setExpirationDate

public void setExpirationDate(java.util.Calendar value)

Sets the value of the <ExpirationDate> element.

The SIF specification defines the meaning of this element as: "Date after which the statistic is no longer valid"

Parameters:

value - A Calendar object

Since:

1.5r1

setExclusionRules

public void setExclusionRules(ExclusionRules value)

Sets the value of the <ExclusionRules> element.

The SIF specification defines the meaning of this element as: "Rule for which statistic may not be reported"

Parameters:

value - A ExclusionRules object

Since:

1.5r1

getExclusionRules

public ExclusionRules getExclusionRules()

Gets the value of the <ExclusionRules> element.

The SIF specification defines the meaning of this element as: "Rule for which statistic may not be reported"

Returns:

An ExclusionRules object

Since:

1.5r1

removeExclusionRules

public void removeExclusionRules()

Removes the ExclusionRules child element previously created by calling setExclusionRules

Since:

1.5r1

getSource

public java.lang.String getSource()

Gets the value of the <Source> element.

The SIF specification defines the meaning of this element as: "System providing the data: i.e., SIS, Transportation,"

Returns:

The Source element of this object.

Since:

1.5r1

setSource

public void setSource(java.lang.String value)

Sets the value of the <Source> element.

The SIF specification defines the meaning of this element as: "System providing the data: i.e., SIS, Transportation,"

Parameters:

value - A String object

Since:

1.5r1

getEffectiveDate

public java.util.Calendar getEffectiveDate()

Gets the value of the <EffectiveDate> element.

The SIF specification defines the meaning of this element as: "Effective date of the statistic"

Returns:

The EffectiveDate element of this object.

Since:

1.5r1

setEffectiveDate

public void setEffectiveDate(java.util.Calendar value)

Sets the value of the <EffectiveDate> element.

The SIF specification defines the meaning of this element as: "Effective date of the statistic"

Parameters:

value - A Calendar object

Since:

1.5r1

getDiscontinueDate

public java.util.Calendar getDiscontinueDate()

Gets the value of the <DiscontinueDate> element.

The SIF specification defines the meaning of this element as: "Discontinue date of the statistic"

Returns:

The DiscontinueDate element of this object.

Since:

1.5r1

setDiscontinueDate

public void setDiscontinueDate(java.util.Calendar value)

Sets the value of the <DiscontinueDate> element.

The SIF specification defines the meaning of this element as: "Discontinue date of the statistic"

Parameters:

value - A Calendar object

Since:

1.5r1

setLocation

public void setLocation(Location value)

Sets the value of the <Location> element.

Parameters:

value - A Location object

Since:

1.5r1

setLocation

public void setLocation(LocationType type)

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

Parameters:

type - Values: Classroom, School, District, Campus, IntermediateUnit, StateEducationAgency

Since:

1.5r1

getLocation

public Location getLocation()

Gets the value of the <Location> element.

Returns:

A Location object

Since:

1.5r1

removeLocation

public void removeLocation()

Removes the Location child element previously created by calling setLocation

Since:

1.5r1

getMeasure

public java.lang.String getMeasure()

Gets the value of the <Measure> element.

The SIF specification defines the meaning of this element as: "Type of the statistic."

Returns:

The Measure element of this object.

Since:

1.5r1

setMeasure

public void setMeasure(MeasureType value)

Sets the value of the <Measure> element.

The SIF specification defines the meaning of this element as: "Type of the statistic."

Parameters:

value - A constant defined by the MeasureType class

Since:

1.5r1

setMeasure

public void setMeasure(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Type of the statistic."

Parameters:

value - The value as a String

Since:

1.5r1