org.ota.shared
Class RelativePosition

java.lang.Object
  org.ota.shared.RelativePosition

Direct Known Subclasses:

RefPoints.RefPoint

public class RelativePosition
extends java.lang.Object

The RelativePosition object contains information about the direction, distance and travel time to/from a facility (hotel, car rental location, or airport) or to/from a designated location. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="RelativePositionType">
   <xs:complexContent>
     <xs:extension base="ns:TransportationsType">
       <xs:attributeGroup ref="ns:RelativePositionGroup"/>
       <xs:attribute type="xs:boolean" use="optional" name="Nearest"/>
       <xs:attribute type="xs:string" use="optional" name="IndexPointCode"/>
       <xs:attribute type="xs:string" use="optional" name="Name"/>
       <xs:attribute type="xs:boolean" use="optional" name="PrimaryIndicator"/>
       <xs:attribute use="optional" name="ToFrom">
         <xs:simpleType>
           <!-- Reference to inner class ToFrom -->
         </xs:simpleType>
       </xs:attribute>
       <xs:attribute type="xs:boolean" use="optional" name="ApproximateDistanceInd"/>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>
 
 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="TransportationsType">
   <xs:sequence>
     <xs:element type="ns:TransportationType" name="Transportations" minOccurs="0"/>
   </xs:sequence>
 </xs:complexType>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="RelativePositionGroup">
   <xs:attribute type="xs:string" use="optional" name="Direction"/>
   <xs:attribute type="xs:string" use="optional" name="Distance"/>
   <xs:attribute type="ns:DistanceUnitNameType" use="optional" name="DistanceUnitName"/>
   <xs:attribute type="xs:string" use="optional" name="UnitOfMeasureCode"/>
 </xs:attributeGroup>
 

Nested Class Summary

static class

RelativePosition.ToFrom Schema fragment(s) for this class:

Constructor Summary

RelativePosition()

Method Summary

java.lang.Boolean	getApproximateDistanceInd() Get the 'ApproximateDistanceInd' attribute value.
java.lang.String	getDirection() Get the 'Direction' attribute value.
java.lang.String	getDistance() Get the 'Distance' attribute value.
DistanceUnitName	getDistanceUnitName() Get the 'DistanceUnitName' attribute value.
java.lang.String	getIndexPointCode() Get the 'IndexPointCode' attribute value.
java.lang.String	getName() Get the 'Name' attribute value.
java.lang.Boolean	getNearest() Get the 'Nearest' attribute value.
java.lang.Boolean	getPrimaryIndicator() Get the 'PrimaryIndicator' attribute value.
RelativePosition.ToFrom	getToFrom() Get the 'ToFrom' attribute value.
Transportation	getTransportations() Get the 'Transportations' element value.
java.lang.String	getUnitOfMeasureCode() Get the 'UnitOfMeasureCode' attribute value.
void	setApproximateDistanceInd(java.lang.Boolean approximateDistanceInd) Set the 'ApproximateDistanceInd' attribute value.
void	setDirection(java.lang.String direction) Set the 'Direction' attribute value.
void	setDistance(java.lang.String distance) Set the 'Distance' attribute value.
void	setDistanceUnitName(DistanceUnitName distanceUnitName) Set the 'DistanceUnitName' attribute value.
void	setIndexPointCode(java.lang.String indexPointCode) Set the 'IndexPointCode' attribute value.
void	setName(java.lang.String name) Set the 'Name' attribute value.
void	setNearest(java.lang.Boolean nearest) Set the 'Nearest' attribute value.
void	setPrimaryIndicator(java.lang.Boolean primaryIndicator) Set the 'PrimaryIndicator' attribute value.
void	setToFrom(RelativePosition.ToFrom toFrom) Set the 'ToFrom' attribute value.
void	setTransportations(Transportation transportations) Set the 'Transportations' element value.
void	setUnitOfMeasureCode(java.lang.String unitOfMeasureCode) Set the 'UnitOfMeasureCode' attribute value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelativePosition

public RelativePosition()

Method Detail

getTransportations

public Transportation getTransportations()

Get the 'Transportations' element value. Collection of directions to/from a specific location via various modes of transportation

Returns:

value

setTransportations

public void setTransportations(Transportation transportations)

Set the 'Transportations' element value. Collection of directions to/from a specific location via various modes of transportation

Parameters:

transportations -

getDirection

public java.lang.String getDirection()

Get the 'Direction' attribute value. Defines the cardinal direction (e.g., north, south, southwest).

Returns:

value

setDirection

public void setDirection(java.lang.String direction)

Set the 'Direction' attribute value. Defines the cardinal direction (e.g., north, south, southwest).

Parameters:

direction -

getDistance

public java.lang.String getDistance()

Get the 'Distance' attribute value. Defines the distance between two points.

Returns:

value

setDistance

public void setDistance(java.lang.String distance)

Set the 'Distance' attribute value. Defines the distance between two points.

Parameters:

distance -

getDistanceUnitName

public DistanceUnitName getDistanceUnitName()

Get the 'DistanceUnitName' attribute value. Candidate for potential removal, usage is not recommended. Deprecation Warning added in 2006A. Provides the ability to specify the unit of measure to which the "Distance" attribute is referring.

Returns:

value

setDistanceUnitName

public void setDistanceUnitName(DistanceUnitName distanceUnitName)

Set the 'DistanceUnitName' attribute value. Candidate for potential removal, usage is not recommended. Deprecation Warning added in 2006A. Provides the ability to specify the unit of measure to which the "Distance" attribute is referring.

Parameters:

distanceUnitName -

getUnitOfMeasureCode

public java.lang.String getUnitOfMeasureCode()

Get the 'UnitOfMeasureCode' attribute value. The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM).

Returns:

value

setUnitOfMeasureCode

public void setUnitOfMeasureCode(java.lang.String unitOfMeasureCode)

Set the 'UnitOfMeasureCode' attribute value. The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM).

Parameters:

unitOfMeasureCode -

getNearest

public java.lang.Boolean getNearest()

Get the 'Nearest' attribute value. The indicator for whether this location is nearest.

Returns:

value

setNearest

public void setNearest(java.lang.Boolean nearest)

Set the 'Nearest' attribute value. The indicator for whether this location is nearest.

Parameters:

nearest -

getIndexPointCode

public java.lang.String getIndexPointCode()

Get the 'IndexPointCode' attribute value. This is the object referred to by the relative position (e.g. cross street, airport). Refer to OpenTravel Code List Index Point Code (IPC).

Returns:

value

setIndexPointCode

public void setIndexPointCode(java.lang.String indexPointCode)

Set the 'IndexPointCode' attribute value. This is the object referred to by the relative position (e.g. cross street, airport). Refer to OpenTravel Code List Index Point Code (IPC).

Parameters:

indexPointCode -

getName

public java.lang.String getName()

Get the 'Name' attribute value. This is used to accommodate a city name, rail station name etc. when using the indexPoint attribute.

Returns:

value

setName

public void setName(java.lang.String name)

Set the 'Name' attribute value. This is used to accommodate a city name, rail station name etc. when using the indexPoint attribute.

Parameters:

name -

getPrimaryIndicator

public java.lang.Boolean getPrimaryIndicator()

Get the 'PrimaryIndicator' attribute value. Indicates whether the reference point is considered the main reference point for the specific type of IndexPointCode (e.g., in Dallas, where IndexPointCode=airport Dallas/Fort Worth airport would be the primary airport even if another airport such as Love Field is closer).

Returns:

value

setPrimaryIndicator

public void setPrimaryIndicator(java.lang.Boolean primaryIndicator)

Set the 'PrimaryIndicator' attribute value. Indicates whether the reference point is considered the main reference point for the specific type of IndexPointCode (e.g., in Dallas, where IndexPointCode=airport Dallas/Fort Worth airport would be the primary airport even if another airport such as Love Field is closer).

Parameters:

primaryIndicator -

getToFrom

public RelativePosition.ToFrom getToFrom()

Get the 'ToFrom' attribute value. Used to indicate whether the context is to a facility or from a facility.

Returns:

value

setToFrom

public void setToFrom(RelativePosition.ToFrom toFrom)

Set the 'ToFrom' attribute value. Used to indicate whether the context is to a facility or from a facility.

Parameters:

toFrom -

getApproximateDistanceInd

public java.lang.Boolean getApproximateDistanceInd()

Get the 'ApproximateDistanceInd' attribute value. When true, the distance information is approximate.

Returns:

value

setApproximateDistanceInd

public void setApproximateDistanceInd(java.lang.Boolean approximateDistanceInd)

Set the 'ApproximateDistanceInd' attribute value. When true, the distance information is approximate.

Parameters:

approximateDistanceInd -