com.edustructures.sifworks.trans
Class BusStopInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class BusStopInfo
extends SIFDataObject

This object contains information about a bus stop.

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

BusStopInfo()
Constructor

BusStopInfo(java.lang.String refId, java.lang.String description)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the <Description> element.
GridLocation	getGridLocation() Gets the value of the <GridLocation> 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	removeGridLocation() Removes the GridLocation child element previously created by calling setGridLocation
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setGridLocation(java.math.BigDecimal latitude, java.math.BigDecimal longitude) Sets the value of the <GridLocation> child element.
void	setGridLocation(GridLocation value) Sets the value of the <GridLocation> 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

BusStopInfo

public BusStopInfo()

Constructor

BusStopInfo

public BusStopInfo(java.lang.String refId,
                   java.lang.String description)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this location.

description - An explanation of this location.

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

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

Parameters:

value - A String 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: "An explanation of this location."

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: "An explanation of this location."

Parameters:

value - A String object

Since:

1.1

setGridLocation

public void setGridLocation(GridLocation value)

Sets the value of the <GridLocation> element.

The SIF specification defines the meaning of this element as: "The location of the bus stop."

Parameters:

value - A GridLocation object

Since:

1.1

setGridLocation

public void setGridLocation(java.math.BigDecimal latitude,
                            java.math.BigDecimal longitude)

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

Parameters:

latitude - The latitude coordinate of this location expressed in decimal format (e.g. "41.7699657")

longitude - The longitude coordinate of this location expressed in decimal format (e.g. "79.548445")

Since:

1.1

getGridLocation

public GridLocation getGridLocation()

Gets the value of the <GridLocation> element.

The SIF specification defines the meaning of this element as: "The location of the bus stop."

Returns:

A GridLocation object

Since:

1.1

removeGridLocation

public void removeGridLocation()

Removes the GridLocation child element previously created by calling setGridLocation

Since:

1.1