com.edustructures.sifworks.common
Class Race

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.Race

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Race
extends SIFKeyedElement

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Race()
Constructor

Race(java.lang.String type, RaceType code)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getCode() Gets the value of the Code attribute.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
OtherCodeList	getOtherCodeList() Gets the value of the <OtherCodeList> element.
java.math.BigDecimal	getProportion() Gets the value of the <Proportion> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeOtherCodeList() Removes the OtherCodeList child element previously created by calling setOtherCodeList
void	setCode(RaceType value) Sets the value of the Code attribute.
void	setCode(java.lang.String value) Sets the value of the Code attribute as a String.
void	setOtherCodeList(OtherCodeList value) Sets the value of the <OtherCodeList> element.
void	setProportion(java.math.BigDecimal value) Sets the value of the <Proportion> element.
void	setType(java.lang.String value) Sets the value of the Type attribute.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, 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

Constructor Detail

Race

public Race()

Constructor

Race

public Race(java.lang.String type,
            RaceType code)

Constructor that accepts values for all mandatory fields

Parameters:

type - A code that specifies the coding structure used. The default is "NA".

code - The general racial category which reflects the individual's recognition of his or her community or with which the individual most identifies.

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

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "A code that specifies the coding structure used. The default is "NA"."

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "A code that specifies the coding structure used. The default is "NA"."

Parameters:

value - A String object

Since:

1.1

getCode

public java.lang.String getCode()

Gets the value of the Code attribute.

The SIF specification defines the meaning of this attribute as: "The general racial category which reflects the individual's recognition of his or her community or with which the individual most identifies."

Returns:

The Code attribute of this object.

Since:

1.1

setCode

public void setCode(RaceType value)

Sets the value of the Code attribute.

The SIF specification defines the meaning of this attribute as: "The general racial category which reflects the individual's recognition of his or her community or with which the individual most identifies."

Parameters:

value - A constant defined by the RaceType class

Since:

1.1

setCode

public void setCode(java.lang.String value)

Sets the value of the Code attribute as a String.

The SIF specification defines the meaning of this attribute as: "The general racial category which reflects the individual's recognition of his or her community or with which the individual most identifies."

Parameters:

value - The value as a String

Since:

1.1

setOtherCodeList

public void setOtherCodeList(OtherCodeList value)

Sets the value of the <OtherCodeList> element.

Parameters:

value - A OtherCodeList object

Since:

2.0

getOtherCodeList

public OtherCodeList getOtherCodeList()

Gets the value of the <OtherCodeList> element.

Returns:

An OtherCodeList object

Since:

2.0

removeOtherCodeList

public void removeOtherCodeList()

Removes the OtherCodeList child element previously created by calling setOtherCodeList

Since:

2.0

getProportion

public java.math.BigDecimal getProportion()

Gets the value of the <Proportion> element.

The SIF specification defines the meaning of this element as: "A percentage associated with the race."

Returns:

The Proportion element of this object.

Since:

1.1

setProportion

public void setProportion(java.math.BigDecimal value)

Sets the value of the <Proportion> element.

The SIF specification defines the meaning of this element as: "A percentage associated with the race."

Parameters:

value - A BigDecimal object

Since:

1.1