com.edustructures.sifworks.trans
Class BusRouteInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.trans.BusRouteInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class BusRouteInfo
extends SIFDataObject

This object contains all of the information about a bus route

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

BusRouteInfo()
Constructor

BusRouteInfo(java.lang.String refId, java.lang.String busInfoRefId, java.lang.String routeNumber, RouteType routeType)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getBusInfoRefId() Gets the value of the <BusInfoRefId> element.
java.lang.String	getDescription() Gets the value of the <Description> 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.Integer	getMaximumLoad() Gets the value of the <MaximumLoad> element.
Name	getName() Gets the value of the <Name> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
RouteDistance	getRouteDistanceLoaded() Gets the value of the <RouteDistanceLoaded> element.
RouteDistance	getRouteDistanceTotal() Gets the value of the <RouteDistanceTotal> element.
javax.xml.datatype.Duration	getRouteDurationLoaded() Gets the value of the <RouteDurationLoaded> element.
javax.xml.datatype.Duration	getRouteDurationTotal() Gets the value of the <RouteDurationTotal> element.
java.lang.String	getRouteNumber() Gets the value of the <RouteNumber> element.
java.lang.String	getRouteType() Gets the value of the <RouteType> element.
void	removeName() Removes the Name child element previously created by calling setName
void	removeRouteDistanceLoaded() Removes the RouteDistanceLoaded child element previously created by calling setRouteDistanceLoaded
void	removeRouteDistanceTotal() Removes the RouteDistanceTotal child element previously created by calling setRouteDistanceTotal
void	setBusInfoRefId(java.lang.String value) Sets the value of the <BusInfoRefId> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setMaximumLoad(java.lang.Integer value) Sets the value of the <MaximumLoad> element.
void	setName(Name value) Sets the value of the <Name> element.
void	setName(NameType type, java.lang.String lastName, java.lang.String firstName) Sets the value of the <Name> child element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setRouteDistanceLoaded(DistanceUnit unit, java.lang.String value) Sets the value of the <RouteDistanceLoaded> child element.
void	setRouteDistanceLoaded(RouteDistance value) Sets the value of the <RouteDistanceLoaded> element.
void	setRouteDistanceTotal(DistanceUnit unit, java.lang.String value) Sets the value of the <RouteDistanceTotal> child element.
void	setRouteDistanceTotal(RouteDistance value) Sets the value of the <RouteDistanceTotal> element.
void	setRouteDurationLoaded(javax.xml.datatype.Duration value) Sets the value of the <RouteDurationLoaded> element.
void	setRouteDurationTotal(javax.xml.datatype.Duration value) Sets the value of the <RouteDurationTotal> element.
void	setRouteNumber(java.lang.String value) Sets the value of the <RouteNumber> element.
void	setRouteType(RouteType value) Sets the value of the <RouteType> element.
void	setRouteType(java.lang.String value) Sets the value of the <RouteType> element as a String.

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

BusRouteInfo

public BusRouteInfo()

Constructor

BusRouteInfo

public BusRouteInfo(java.lang.String refId,
                    java.lang.String busInfoRefId,
                    java.lang.String routeNumber,
                    RouteType routeType)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this bus route.

busInfoRefId - The bus associated with this route

routeNumber - A unique identifier for the route. It may contain any printable ASCII character. For instance, you may have route 16AM in the morning and a 16PM in the afternoon.

routeType - The type of route.

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: "GUID that identifies this bus route."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.1

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: "GUID that identifies this bus route."

Parameters:

value - A String object

Since:

1.1

getBusInfoRefId

public java.lang.String getBusInfoRefId()

Gets the value of the <BusInfoRefId> element.

The SIF specification defines the meaning of this element as: "The bus associated with this route"

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.1	"Bus"
SIF2.0	"BusInfoRefId"

Returns:

The BusInfoRefId element of this object.

Since:

1.1

setBusInfoRefId

public void setBusInfoRefId(java.lang.String value)

Sets the value of the <BusInfoRefId> element.

The SIF specification defines the meaning of this element as: "The bus associated with this route"

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.1	"Bus"
SIF2.0	"BusInfoRefId"

Parameters:

value - A String object

Since:

1.1

getRouteNumber

public java.lang.String getRouteNumber()

Gets the value of the <RouteNumber> element.

The SIF specification defines the meaning of this element as: "A unique identifier for the route. It may contain any printable ASCII character. For instance, you may have route 16AM in the morning and a 16PM in the afternoon."

Returns:

The RouteNumber element of this object.

Since:

1.1

setRouteNumber

public void setRouteNumber(java.lang.String value)

Sets the value of the <RouteNumber> element.

The SIF specification defines the meaning of this element as: "A unique identifier for the route. It may contain any printable ASCII character. For instance, you may have route 16AM in the morning and a 16PM in the afternoon."

Parameters:

value - A String object

Since:

1.1

getRouteType

public java.lang.String getRouteType()

Gets the value of the <RouteType> element.

The SIF specification defines the meaning of this element as: "The type of route."

Returns:

The RouteType element of this object.

Since:

1.1

setRouteType

public void setRouteType(RouteType value)

Sets the value of the <RouteType> element.

The SIF specification defines the meaning of this element as: "The type of route."

Parameters:

value - A constant defined by the RouteType class

Since:

1.1

setRouteType

public void setRouteType(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "The type of route."

Parameters:

value - The value as a String

Since:

1.1

getMaximumLoad

public java.lang.Integer getMaximumLoad()

Gets the value of the <MaximumLoad> element.

The SIF specification defines the meaning of this element as: "The maximum number of students who are on the bus at any point along this route."

Returns:

The MaximumLoad element of this object.

Since:

1.1

setMaximumLoad

public void setMaximumLoad(java.lang.Integer value)

Sets the value of the <MaximumLoad> element.

The SIF specification defines the meaning of this element as: "The maximum number of students who are on the bus at any point along this route."

Parameters:

value - A Integer object

Since:

1.1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Short explanation of the route. It may be used to designate an area, or used to color-code bus routes (the "orange" route)."

Returns:

The Description element of this object.

Since:

1.1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Short explanation of the route. It may be used to designate an area, or used to color-code bus routes (the "orange" route)."

Parameters:

value - A String object

Since:

1.1

setName

public void setName(Name value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of the driver who drives this route."

Parameters:

value - A Name object

Since:

1.1

setName

public void setName(NameType type,
                    java.lang.String lastName,
                    java.lang.String firstName)

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

Parameters:

type - Code that specifies what type of name this is. If unsure, use 04.

lastName - The last name.

firstName - The first name.

Since:

1.1

getName

public Name getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of the driver who drives this route."

Returns:

A Name object

Since:

1.1

removeName

public void removeName()

Removes the Name child element previously created by calling setName

Since:

1.1

getRouteDurationLoaded

public javax.xml.datatype.Duration getRouteDurationLoaded()

Gets the value of the <RouteDurationLoaded> 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.1	"RouteDuration"
SIF2.0	"RouteDurationLoaded"

Returns:

The RouteDurationLoaded element of this object.

Since:

1.1

setRouteDurationLoaded

public void setRouteDurationLoaded(javax.xml.datatype.Duration value)

Sets the value of the <RouteDurationLoaded> 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.1	"RouteDuration"
SIF2.0	"RouteDurationLoaded"

Parameters:

value - A javax.xml.datatype.Duration object

Since:

1.1

getRouteDurationTotal

public javax.xml.datatype.Duration getRouteDurationTotal()

Gets the value of the <RouteDurationTotal> 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.1	"RouteDuration"
SIF2.0	"RouteDurationTotal"

Returns:

The RouteDurationTotal element of this object.

Since:

1.1

setRouteDurationTotal

public void setRouteDurationTotal(javax.xml.datatype.Duration value)

Sets the value of the <RouteDurationTotal> 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.1	"RouteDuration"
SIF2.0	"RouteDurationTotal"

Parameters:

value - A javax.xml.datatype.Duration object

Since:

1.1

setRouteDistanceLoaded

public void setRouteDistanceLoaded(RouteDistance value)

Sets the value of the <RouteDistanceLoaded> element.

The SIF specification defines the meaning of this element as: "Refers to the distance the bus drives when at least one student is riding the bus."

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.1	"RouteDistance"
SIF2.0	"RouteDistanceLoaded"

Parameters:

value - A RouteDistance object

Since:

1.1

setRouteDistanceLoaded

public void setRouteDistanceLoaded(DistanceUnit unit,
                                   java.lang.String value)

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

Parameters:

unit - Units used in the odometer reading.

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

Since:

1.1

getRouteDistanceLoaded

public RouteDistance getRouteDistanceLoaded()

Gets the value of the <RouteDistanceLoaded> element.

The SIF specification defines the meaning of this element as: "Refers to the distance the bus drives when at least one student is riding the bus."

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.1	"RouteDistance"
SIF2.0	"RouteDistanceLoaded"

Returns:

A RouteDistance object

Since:

1.1

removeRouteDistanceLoaded

public void removeRouteDistanceLoaded()

Removes the RouteDistanceLoaded child element previously created by calling setRouteDistanceLoaded

Since:

1.1

setRouteDistanceTotal

public void setRouteDistanceTotal(RouteDistance value)

Sets the value of the <RouteDistanceTotal> element.

The SIF specification defines the meaning of this element as: "Includes the total distance driven for this route including to and from garage."

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.1	"RouteDistance"
SIF2.0	"RouteDistanceTotal"

Parameters:

value - A RouteDistance object

Since:

1.1

setRouteDistanceTotal

public void setRouteDistanceTotal(DistanceUnit unit,
                                  java.lang.String value)

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

Parameters:

unit - Units used in the odometer reading.

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

Since:

1.1

getRouteDistanceTotal

public RouteDistance getRouteDistanceTotal()

Gets the value of the <RouteDistanceTotal> element.

The SIF specification defines the meaning of this element as: "Includes the total distance driven for this route including to and from garage."

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.1	"RouteDistance"
SIF2.0	"RouteDistanceTotal"

Returns:

A RouteDistance object

Since:

1.1

removeRouteDistanceTotal

public void removeRouteDistanceTotal()

Removes the RouteDistanceTotal child element previously created by calling setRouteDistanceTotal

Since:

1.1