com.esri.arcgisws
Class NAServerRouteParams

java.lang.Object
  extended by com.esri.arcgisws.NAServerSolverParams
      extended by com.esri.arcgisws.NAServerRouteParams
All Implemented Interfaces:
Serializable

public class NAServerRouteParams
extends NAServerSolverParams
implements Serializable

Java class for NAServerRouteParams complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="NAServerRouteParams">
   <complexContent>
     <extension base="{http://www.esri.com/schemas/ArcGIS/10.0}NAServerSolverParams">
       <sequence>
         <element name="Stops" type="{http://www.esri.com/schemas/ArcGIS/10.0}NAServerLocations" minOccurs="0"/>
         <element name="Barriers" type="{http://www.esri.com/schemas/ArcGIS/10.0}NAServerLocations" minOccurs="0"/>
         <element name="ReturnRouteGeometries" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="ReturnRoutes" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="ReturnStops" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="ReturnBarriers" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="ReturnDirections" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="DirectionsLanguage" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="DirectionsLengthUnits" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriNetworkAttributeUnits"/>
         <element name="DirectionsTimeAttributeName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="FindBestSequence" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="PreserveFirstStop" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="PreserveLastStop" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="UseTimeWindows" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="CreateTraversalResult" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="OutputLines" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriNAOutputLineType"/>
         <element name="UseStartTime" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="StartTime" type="{http://www.w3.org/2001/XMLSchema}dateTime"/>
         <element name="ReturnCompactDirections" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="DirectionsOutputType" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriDirectionsOutputType" minOccurs="0"/>
         <element name="DirectionsStyleName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="PolygonBarriers" type="{http://www.esri.com/schemas/ArcGIS/10.0}NAServerLocations" minOccurs="0"/>
         <element name="PolylineBarriers" type="{http://www.esri.com/schemas/ArcGIS/10.0}NAServerLocations" minOccurs="0"/>
         <element name="ReturnPolygonBarriers" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="ReturnPolylineBarriers" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

See Also:
Serialized Form

Constructor Summary
NAServerRouteParams()
          NAServerRouteParams default constructor.
NAServerRouteParams(String naLayerName, double snapTolerance, double maxSnapTolerance, EsriUnits snapToleranceUnits, NAClassCandidateFieldMap[] naClassCandidateFieldMaps, boolean returnMap, MapDescription mapDescription, ImageDescription imageDescription, SpatialReference outputSpatialReference, boolean returnGeometriesAsBinary, String[] accumulateAttributeNames, String impedanceAttributeName, boolean ignoreInvalidLocations, EsriNetworkForwardStarBacktrack restrictUTurns, String[] restrictionAttributeNames, boolean useHierarchy, String hierarchyAttributeName, int hierarchyLevelCount, int[] hierarchyMaxValues, int[] hierarchyNumTransitions, boolean resetHierarchyRangesOnBind, NAAttributeParameterValue[] attributeParameterValues, Object outputGeometryPrecision, EsriUnits outputGeometryPrecisionUnits, Boolean returnPartialResultsOnError, Boolean saveLayerOnServer, String layerToken, NAServerLocations stops, NAServerLocations barriers, boolean returnRouteGeometries, boolean returnRoutes, boolean returnStops, boolean returnBarriers, boolean returnDirections, String directionsLanguage, EsriNetworkAttributeUnits directionsLengthUnits, String directionsTimeAttributeName, boolean findBestSequence, boolean preserveFirstStop, boolean preserveLastStop, boolean useTimeWindows, boolean createTraversalResult, EsriNAOutputLineType outputLines, boolean useStartTime, javax.xml.datatype.XMLGregorianCalendar startTime, boolean returnCompactDirections, EsriDirectionsOutputType directionsOutputType, String directionsStyleName, NAServerLocations polygonBarriers, NAServerLocations polylineBarriers, Boolean returnPolygonBarriers, Boolean returnPolylineBarriers)
          Deprecated. 
 
Method Summary
 NAServerLocations getBarriers()
          Gets the value of the barriers property.
 String getDirectionsLanguage()
          Gets the value of the directionsLanguage property.
 EsriNetworkAttributeUnits getDirectionsLengthUnits()
          Gets the value of the directionsLengthUnits property.
 EsriDirectionsOutputType getDirectionsOutputType()
          Gets the value of the directionsOutputType property.
 String getDirectionsStyleName()
          Gets the value of the directionsStyleName property.
 String getDirectionsTimeAttributeName()
          Gets the value of the directionsTimeAttributeName property.
 EsriNAOutputLineType getOutputLines()
          Gets the value of the outputLines property.
 NAServerLocations getPolygonBarriers()
          Gets the value of the polygonBarriers property.
 NAServerLocations getPolylineBarriers()
          Gets the value of the polylineBarriers property.
 Boolean getReturnPolygonBarriers()
          Gets the value of the returnPolygonBarriers property.
 Boolean getReturnPolylineBarriers()
          Gets the value of the returnPolylineBarriers property.
 javax.xml.datatype.XMLGregorianCalendar getStartTime()
          Gets the value of the startTime property.
 NAServerLocations getStops()
          Gets the value of the stops property.
 boolean isCreateTraversalResult()
          Gets the value of the createTraversalResult property.
 boolean isFindBestSequence()
          Gets the value of the findBestSequence property.
 boolean isPreserveFirstStop()
          Gets the value of the preserveFirstStop property.
 boolean isPreserveLastStop()
          Gets the value of the preserveLastStop property.
 boolean isReturnBarriers()
          Gets the value of the returnBarriers property.
 boolean isReturnCompactDirections()
          Gets the value of the returnCompactDirections property.
 boolean isReturnDirections()
          Gets the value of the returnDirections property.
 Boolean isReturnPolygonBarriers()
           
 Boolean isReturnPolylineBarriers()
           
 boolean isReturnRouteGeometries()
          Gets the value of the returnRouteGeometries property.
 boolean isReturnRoutes()
          Gets the value of the returnRoutes property.
 boolean isReturnStops()
          Gets the value of the returnStops property.
 boolean isUseStartTime()
          Gets the value of the useStartTime property.
 boolean isUseTimeWindows()
          Gets the value of the useTimeWindows property.
 void setBarriers(NAServerLocations value)
          Sets the value of the barriers property.
 void setCreateTraversalResult(boolean value)
          Sets the value of the createTraversalResult property.
 void setDirectionsLanguage(String value)
          Sets the value of the directionsLanguage property.
 void setDirectionsLengthUnits(EsriNetworkAttributeUnits value)
          Sets the value of the directionsLengthUnits property.
 void setDirectionsOutputType(EsriDirectionsOutputType value)
          Sets the value of the directionsOutputType property.
 void setDirectionsStyleName(String value)
          Sets the value of the directionsStyleName property.
 void setDirectionsTimeAttributeName(String value)
          Sets the value of the directionsTimeAttributeName property.
 void setFindBestSequence(boolean value)
          Sets the value of the findBestSequence property.
 void setOutputLines(EsriNAOutputLineType value)
          Sets the value of the outputLines property.
 void setPolygonBarriers(NAServerLocations value)
          Sets the value of the polygonBarriers property.
 void setPolylineBarriers(NAServerLocations value)
          Sets the value of the polylineBarriers property.
 void setPreserveFirstStop(boolean value)
          Sets the value of the preserveFirstStop property.
 void setPreserveLastStop(boolean value)
          Sets the value of the preserveLastStop property.
 void setReturnBarriers(boolean value)
          Sets the value of the returnBarriers property.
 void setReturnCompactDirections(boolean value)
          Sets the value of the returnCompactDirections property.
 void setReturnDirections(boolean value)
          Sets the value of the returnDirections property.
 void setReturnPolygonBarriers(Boolean value)
          Sets the value of the returnPolygonBarriers property.
 void setReturnPolylineBarriers(Boolean value)
          Sets the value of the returnPolylineBarriers property.
 void setReturnRouteGeometries(boolean value)
          Sets the value of the returnRouteGeometries property.
 void setReturnRoutes(boolean value)
          Sets the value of the returnRoutes property.
 void setReturnStops(boolean value)
          Sets the value of the returnStops property.
 void setStartTime(javax.xml.datatype.XMLGregorianCalendar value)
          Sets the value of the startTime property.
 void setStops(NAServerLocations value)
          Sets the value of the stops property.
 void setUseStartTime(boolean value)
          Sets the value of the useStartTime property.
 void setUseTimeWindows(boolean value)
          Sets the value of the useTimeWindows property.
 
Methods inherited from class com.esri.arcgisws.NAServerSolverParams
getAccumulateAttributeNames, getAttributeParameterValues, getHierarchyAttributeName, getHierarchyLevelCount, getHierarchyMaxValues, getHierarchyNumTransitions, getImageDescription, getImpedanceAttributeName, getLayerToken, getMapDescription, getMaxSnapTolerance, getNAClassCandidateFieldMaps, getNALayerName, getOutputGeometryPrecision, getOutputGeometryPrecisionUnits, getOutputSpatialReference, getRestrictionAttributeNames, getRestrictUTurns, getReturnPartialResultsOnError, getSaveLayerOnServer, getSnapTolerance, getSnapToleranceUnits, isIgnoreInvalidLocations, isResetHierarchyRangesOnBind, isReturnGeometriesAsBinary, isReturnMap, isReturnPartialResultsOnError, isSaveLayerOnServer, isUseHierarchy, setAccumulateAttributeNames, setAttributeParameterValues, setHierarchyAttributeName, setHierarchyLevelCount, setHierarchyMaxValues, setHierarchyNumTransitions, setIgnoreInvalidLocations, setImageDescription, setImpedanceAttributeName, setLayerToken, setMapDescription, setMaxSnapTolerance, setNAClassCandidateFieldMaps, setNALayerName, setOutputGeometryPrecision, setOutputGeometryPrecisionUnits, setOutputSpatialReference, setResetHierarchyRangesOnBind, setRestrictionAttributeNames, setRestrictUTurns, setReturnGeometriesAsBinary, setReturnMap, setReturnPartialResultsOnError, setSaveLayerOnServer, setSnapTolerance, setSnapToleranceUnits, setUseHierarchy
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NAServerRouteParams

@Deprecated
public NAServerRouteParams(String naLayerName,
                                      double snapTolerance,
                                      double maxSnapTolerance,
                                      EsriUnits snapToleranceUnits,
                                      NAClassCandidateFieldMap[] naClassCandidateFieldMaps,
                                      boolean returnMap,
                                      MapDescription mapDescription,
                                      ImageDescription imageDescription,
                                      SpatialReference outputSpatialReference,
                                      boolean returnGeometriesAsBinary,
                                      String[] accumulateAttributeNames,
                                      String impedanceAttributeName,
                                      boolean ignoreInvalidLocations,
                                      EsriNetworkForwardStarBacktrack restrictUTurns,
                                      String[] restrictionAttributeNames,
                                      boolean useHierarchy,
                                      String hierarchyAttributeName,
                                      int hierarchyLevelCount,
                                      int[] hierarchyMaxValues,
                                      int[] hierarchyNumTransitions,
                                      boolean resetHierarchyRangesOnBind,
                                      NAAttributeParameterValue[] attributeParameterValues,
                                      Object outputGeometryPrecision,
                                      EsriUnits outputGeometryPrecisionUnits,
                                      Boolean returnPartialResultsOnError,
                                      Boolean saveLayerOnServer,
                                      String layerToken,
                                      NAServerLocations stops,
                                      NAServerLocations barriers,
                                      boolean returnRouteGeometries,
                                      boolean returnRoutes,
                                      boolean returnStops,
                                      boolean returnBarriers,
                                      boolean returnDirections,
                                      String directionsLanguage,
                                      EsriNetworkAttributeUnits directionsLengthUnits,
                                      String directionsTimeAttributeName,
                                      boolean findBestSequence,
                                      boolean preserveFirstStop,
                                      boolean preserveLastStop,
                                      boolean useTimeWindows,
                                      boolean createTraversalResult,
                                      EsriNAOutputLineType outputLines,
                                      boolean useStartTime,
                                      javax.xml.datatype.XMLGregorianCalendar startTime,
                                      boolean returnCompactDirections,
                                      EsriDirectionsOutputType directionsOutputType,
                                      String directionsStyleName,
                                      NAServerLocations polygonBarriers,
                                      NAServerLocations polylineBarriers,
                                      Boolean returnPolygonBarriers,
                                      Boolean returnPolylineBarriers)
Deprecated. 

NAServerRouteParams constructor.


NAServerRouteParams

public NAServerRouteParams()
NAServerRouteParams default constructor.

Method Detail

getStops

public NAServerLocations getStops()
Gets the value of the stops property.

Returns:
possible object is NAServerLocations

setStops

public void setStops(NAServerLocations value)
Sets the value of the stops property.

Parameters:
value - allowed object is NAServerLocations

getBarriers

public NAServerLocations getBarriers()
Gets the value of the barriers property.

Returns:
possible object is NAServerLocations

setBarriers

public void setBarriers(NAServerLocations value)
Sets the value of the barriers property.

Parameters:
value - allowed object is NAServerLocations

isReturnRouteGeometries

public boolean isReturnRouteGeometries()
Gets the value of the returnRouteGeometries property.


setReturnRouteGeometries

public void setReturnRouteGeometries(boolean value)
Sets the value of the returnRouteGeometries property.


isReturnRoutes

public boolean isReturnRoutes()
Gets the value of the returnRoutes property.


setReturnRoutes

public void setReturnRoutes(boolean value)
Sets the value of the returnRoutes property.


isReturnStops

public boolean isReturnStops()
Gets the value of the returnStops property.


setReturnStops

public void setReturnStops(boolean value)
Sets the value of the returnStops property.


isReturnBarriers

public boolean isReturnBarriers()
Gets the value of the returnBarriers property.


setReturnBarriers

public void setReturnBarriers(boolean value)
Sets the value of the returnBarriers property.


isReturnDirections

public boolean isReturnDirections()
Gets the value of the returnDirections property.


setReturnDirections

public void setReturnDirections(boolean value)
Sets the value of the returnDirections property.


getDirectionsLanguage

public String getDirectionsLanguage()
Gets the value of the directionsLanguage property.

Returns:
possible object is String

setDirectionsLanguage

public void setDirectionsLanguage(String value)
Sets the value of the directionsLanguage property.

Parameters:
value - allowed object is String

getDirectionsLengthUnits

public EsriNetworkAttributeUnits getDirectionsLengthUnits()
Gets the value of the directionsLengthUnits property.

Returns:
possible object is EsriNetworkAttributeUnits

setDirectionsLengthUnits

public void setDirectionsLengthUnits(EsriNetworkAttributeUnits value)
Sets the value of the directionsLengthUnits property.

Parameters:
value - allowed object is EsriNetworkAttributeUnits

getDirectionsTimeAttributeName

public String getDirectionsTimeAttributeName()
Gets the value of the directionsTimeAttributeName property.

Returns:
possible object is String

setDirectionsTimeAttributeName

public void setDirectionsTimeAttributeName(String value)
Sets the value of the directionsTimeAttributeName property.

Parameters:
value - allowed object is String

isFindBestSequence

public boolean isFindBestSequence()
Gets the value of the findBestSequence property.


setFindBestSequence

public void setFindBestSequence(boolean value)
Sets the value of the findBestSequence property.


isPreserveFirstStop

public boolean isPreserveFirstStop()
Gets the value of the preserveFirstStop property.


setPreserveFirstStop

public void setPreserveFirstStop(boolean value)
Sets the value of the preserveFirstStop property.


isPreserveLastStop

public boolean isPreserveLastStop()
Gets the value of the preserveLastStop property.


setPreserveLastStop

public void setPreserveLastStop(boolean value)
Sets the value of the preserveLastStop property.


isUseTimeWindows

public boolean isUseTimeWindows()
Gets the value of the useTimeWindows property.


setUseTimeWindows

public void setUseTimeWindows(boolean value)
Sets the value of the useTimeWindows property.


isCreateTraversalResult

public boolean isCreateTraversalResult()
Gets the value of the createTraversalResult property.


setCreateTraversalResult

public void setCreateTraversalResult(boolean value)
Sets the value of the createTraversalResult property.


getOutputLines

public EsriNAOutputLineType getOutputLines()
Gets the value of the outputLines property.

Returns:
possible object is EsriNAOutputLineType

setOutputLines

public void setOutputLines(EsriNAOutputLineType value)
Sets the value of the outputLines property.

Parameters:
value - allowed object is EsriNAOutputLineType

isUseStartTime

public boolean isUseStartTime()
Gets the value of the useStartTime property.


setUseStartTime

public void setUseStartTime(boolean value)
Sets the value of the useStartTime property.


getStartTime

public javax.xml.datatype.XMLGregorianCalendar getStartTime()
Gets the value of the startTime property.

Returns:
possible object is XMLGregorianCalendar

setStartTime

public void setStartTime(javax.xml.datatype.XMLGregorianCalendar value)
Sets the value of the startTime property.

Parameters:
value - allowed object is XMLGregorianCalendar

isReturnCompactDirections

public boolean isReturnCompactDirections()
Gets the value of the returnCompactDirections property.


setReturnCompactDirections

public void setReturnCompactDirections(boolean value)
Sets the value of the returnCompactDirections property.


getDirectionsOutputType

public EsriDirectionsOutputType getDirectionsOutputType()
Gets the value of the directionsOutputType property.

Returns:
possible object is EsriDirectionsOutputType

setDirectionsOutputType

public void setDirectionsOutputType(EsriDirectionsOutputType value)
Sets the value of the directionsOutputType property.

Parameters:
value - allowed object is EsriDirectionsOutputType

getDirectionsStyleName

public String getDirectionsStyleName()
Gets the value of the directionsStyleName property.

Returns:
possible object is String

setDirectionsStyleName

public void setDirectionsStyleName(String value)
Sets the value of the directionsStyleName property.

Parameters:
value - allowed object is String

getPolygonBarriers

public NAServerLocations getPolygonBarriers()
Gets the value of the polygonBarriers property.

Returns:
possible object is NAServerLocations

setPolygonBarriers

public void setPolygonBarriers(NAServerLocations value)
Sets the value of the polygonBarriers property.

Parameters:
value - allowed object is NAServerLocations

getPolylineBarriers

public NAServerLocations getPolylineBarriers()
Gets the value of the polylineBarriers property.

Returns:
possible object is NAServerLocations

setPolylineBarriers

public void setPolylineBarriers(NAServerLocations value)
Sets the value of the polylineBarriers property.

Parameters:
value - allowed object is NAServerLocations

getReturnPolygonBarriers

public Boolean getReturnPolygonBarriers()
Gets the value of the returnPolygonBarriers property.

Returns:
possible object is Boolean

isReturnPolygonBarriers

public Boolean isReturnPolygonBarriers()

setReturnPolygonBarriers

public void setReturnPolygonBarriers(Boolean value)
Sets the value of the returnPolygonBarriers property.

Parameters:
value - allowed object is Boolean

getReturnPolylineBarriers

public Boolean getReturnPolylineBarriers()
Gets the value of the returnPolylineBarriers property.

Returns:
possible object is Boolean

isReturnPolylineBarriers

public Boolean isReturnPolylineBarriers()

setReturnPolylineBarriers

public void setReturnPolylineBarriers(Boolean value)
Sets the value of the returnPolylineBarriers property.

Parameters:
value - allowed object is Boolean