com.edustructures.sifworks.trans
Class BusRouteDetail

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class BusRouteDetail
extends SIFDataObject

The schedule for 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

BusRouteDetail()
Constructor

BusRouteDetail(java.lang.String refId, java.lang.String busRouteInfoRefId, java.lang.String busStopInfoRefId, java.util.Calendar arrivalTime)
Constructor that accepts values for all mandatory fields

Method Summary

java.util.Calendar	getArrivalTime() Gets the value of the <ArrivalTime> element.
java.lang.String	getBusRouteInfoRefId() Gets the value of the BusRouteInfoRefId attribute.
java.lang.String	getBusStopInfoRefId() Gets the value of the <BusStopInfoRefId> 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.String	getRefId() Gets the value of the RefId attribute.
void	setArrivalTime(java.util.Calendar value) Sets the value of the <ArrivalTime> element.
void	setBusRouteInfoRefId(java.lang.String value) Sets the value of the BusRouteInfoRefId attribute.
void	setBusStopInfoRefId(java.lang.String value) Sets the value of the <BusStopInfoRefId> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.

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

BusRouteDetail

public BusRouteDetail()

Constructor

BusRouteDetail

public BusRouteDetail(java.lang.String refId,
                      java.lang.String busRouteInfoRefId,
                      java.lang.String busStopInfoRefId,
                      java.util.Calendar arrivalTime)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this object.

busRouteInfoRefId - GUID that identifies the bus route. See the BusRoute specification for more details.

busStopInfoRefId - Describes a bus stop

arrivalTime - The time that the bus associated with this route will stop at this bus stop.

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 object."

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 object."

Parameters:

value - A String object

Since:

1.1

getBusRouteInfoRefId

public java.lang.String getBusRouteInfoRefId()

Gets the value of the BusRouteInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies the bus route. See the BusRoute specification for more details."

Returns:

The BusRouteInfoRefId attribute of this object.

Since:

1.1

setBusRouteInfoRefId

public void setBusRouteInfoRefId(java.lang.String value)

Sets the value of the BusRouteInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies the bus route. See the BusRoute specification for more details."

Parameters:

value - A String object

Since:

1.1

getBusStopInfoRefId

public java.lang.String getBusStopInfoRefId()

Gets the value of the <BusStopInfoRefId> element.

The SIF specification defines the meaning of this element as: "Describes a bus stop"

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	"BusStop"
SIF2.0	"BusStopInfoRefId"

Returns:

The BusStopInfoRefId element of this object.

Since:

1.1

setBusStopInfoRefId

public void setBusStopInfoRefId(java.lang.String value)

Sets the value of the <BusStopInfoRefId> element.

The SIF specification defines the meaning of this element as: "Describes a bus stop"

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	"BusStop"
SIF2.0	"BusStopInfoRefId"

Parameters:

value - A String object

Since:

1.1

getArrivalTime

public java.util.Calendar getArrivalTime()

Gets the value of the <ArrivalTime> element.

The SIF specification defines the meaning of this element as: "The time that the bus associated with this route will stop at this bus stop."

Returns:

The ArrivalTime element of this object.

Since:

1.1

setArrivalTime

public void setArrivalTime(java.util.Calendar value)

Sets the value of the <ArrivalTime> element.

The SIF specification defines the meaning of this element as: "The time that the bus associated with this route will stop at this bus stop."

Parameters:

value - A Calendar object

Since:

1.1