com.edustructures.sifworks.common
Class RaceList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Race>
                  com.edustructures.sifworks.common.RaceList

All Implemented Interfaces:

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

public class RaceList
extends SIFKeyedList<Race>

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

RaceList()
Constructor

RaceList(Race race)
Constructor that accepts values for all mandatory fields

Method Summary

void	addRace(java.lang.String type, RaceType code) Adds a new <Race> repeatable element.
Race	getRace(RaceType code) Gets a Race object instance.
Race[]	getRaces() Gets all Race object instances.
void	removeRace(RaceType code) Removes a Race object instance.
void	setRaces(Race[] races) Sets an array of Race 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, getKey, 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

RaceList

public RaceList()

Constructor

RaceList

public RaceList(Race race)

Constructor that accepts values for all mandatory fields

Parameters:

race -

Method Detail

addRace

public void addRace(java.lang.String type,
                    RaceType code)

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

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.

Since:

1.1

removeRace

public void removeRace(RaceType code)

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

Parameters:

code - Identifies the Race object to remove by its Code value

Since:

1.1

getRace

public Race getRace(RaceType code)

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

Parameters:

code - Identifies the Race object to return by its "Code" attribute value

Returns:

A Race object

Since:

1.1

getRaces

public Race[] getRaces()

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

Returns:

An array of Race objects

Since:

1.1

setRaces

public void setRaces(Race[] races)

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

Since:

1.1