com.edustructures.sifworks
Class SIFKeyedList<T extends SIFKeyedElement>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Agencies, AlertMessages, AssessmentSubTestRefIds, AssociatedObjects, Authors, BusStaffList, Certifications, Characteristics, ComponentObjects, CountriesOfCitizenship, CountriesOfResidency, Counts, Courses, Creators, CurriculumStructures, ElectronicIdList, EmployeeAssignments, EnrollmentHistory, EquipmentList, EssentialMaterials, ExceptionalityCategories, ExclusionRules, FeesForUse, FineInfoList, FormNumbers, FSAmounts, GradeLevels, HistoricalMealStatus, HoldInfoList, HrOtherIdList, IdentificationInfoList, Items, LanguageList, LEAContactList, LearningObjectives, LearningResources, LearningStandardItemRefIds, LearningStandards, MarkingSystems, MarkList, MediaTypes, MedicalAlertMessages, MenuPlanQuantities, MessageList, ModificationHistory, OffenderList, Organizations, OtherCodeList, OtherIdList, OtherLEAs, OtherRecords, PasswordList, PayRates, PerformanceLevels, PredecessorItems, PredecessorObjects, Prerequisites, Prices, PurchasingItems, R, RaceList, Rates, RelatedLearningStandards, RelatedToList, ReportFormatList, SalesAmounts, ScheduleInfoList, SchoolAttendanceHistory, SchoolContactList, SchoolFocusList, Scores, SectionRoomList, SIF_AddPublishers, SIF_ChangePublishers, SIF_ColumnHeaders, SIF_Contexts, SIF_DeletePublishers, SIF_LogObjects, SIF_ObjectList, SIF_ProvideAccess, SIF_ProvideObjects, SIF_Providers, SIF_PublishAddAccess, SIF_PublishAddObjects, SIF_PublishChangeAccess, SIF_PublishChangeObjects, SIF_PublishDeleteAccess, SIF_PublishDeleteObjects, SIF_QueryGroup, SIF_RequestAccess, SIF_Requesters, SIF_RequestObjects, SIF_RespondAccess, SIF_Responders, SIF_RespondObjects, SIF_SIFNodes, SIF_SubscribeAccess, SIF_SubscribeObjects, SIF_Subscribers, SIF_SupportedAuthentication, SIF_SupportedProtocols, SIF_SupportedVersions, SIF_VersionList, SIFActionList, SourceObjects, StaffList, StatementCodes, Statements, Strategies, StudentSpecialConditions, SubjectAreaList, SubjectAreas, SupportingActivities, TeacherList, TechnicalRequirements, TelemetryList, TimeElements, Titles, TransactionPayMethods, TransactionTypes, VictimList, WeaponTypeList

public class SIFKeyedList<T extends SIFKeyedElement>
extends SIFList<T>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIFKeyedList(ElementDef def)

Method Summary

SIFElement	getChild(ElementDef id, java.lang.String[] compKey) Gets a child object identified by its ElementDef and composite key
SIFElement	getChild(java.lang.String name, java.lang.String key) Gets the child object with the matching element name and key

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

SIFKeyedList

public SIFKeyedList(ElementDef def)

Method Detail

getChild

public SIFElement getChild(java.lang.String name,
                           java.lang.String key)

Gets the child object with the matching element name and key

Overrides:

getChild in class SIFElement

Parameters:

name - The version-independent element name. Note the element name is not necessarily the same as the element tag, which is version dependent.

key - The key to match

Returns:

The SIFElement that has a matching element name and key, or null if no matches found

getChild

public SIFElement getChild(ElementDef id,
                           java.lang.String[] compKey)

Gets a child object identified by its ElementDef and composite key

Overrides:

getChild in class SIFElement

Parameters:

id - A ElementDef defined by the SIFDTD class to uniquely identify this field

compKey - The key values in sequential order

Returns:

The child that was requested, or null