com.esri.arcgisws
Class NAServerClosestFacilityParams

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

public class NAServerClosestFacilityParams
extends NAServerSolverParams
implements Serializable

Java class for NAServerClosestFacilityParams complex type.

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

 <complexType name="NAServerClosestFacilityParams">
   <complexContent>
     <extension base="{http://www.esri.com/schemas/ArcGIS/10.0}NAServerSolverParams">
       <sequence>
         <element name="Facilities" type="{http://www.esri.com/schemas/ArcGIS/10.0}NAServerLocations" minOccurs="0"/>
         <element name="Incidents" 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="ReturnCFRouteGeometries" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="ReturnCFRoutes" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="ReturnFacilities" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="ReturnIncidents" 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="DefaultTargetFacilityCount" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="DefaultCutoff" type="{http://www.w3.org/2001/XMLSchema}anyType" minOccurs="0"/>
         <element name="TravelDirection" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriNATravelDirection"/>
         <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="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
NAServerClosestFacilityParams()
          NAServerClosestFacilityParams default constructor.
NAServerClosestFacilityParams(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 facilities, NAServerLocations incidents, NAServerLocations barriers, boolean returnCFRouteGeometries, boolean returnCFRoutes, boolean returnFacilities, boolean returnIncidents, boolean returnBarriers, boolean returnDirections, String directionsLanguage, EsriNetworkAttributeUnits directionsLengthUnits, String directionsTimeAttributeName, int defaultTargetFacilityCount, Object defaultCutoff, EsriNATravelDirection travelDirection, boolean createTraversalResult, EsriNAOutputLineType outputLines, 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.
 Object getDefaultCutoff()
          Gets the value of the defaultCutoff property.
 int getDefaultTargetFacilityCount()
          Gets the value of the defaultTargetFacilityCount 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.
 NAServerLocations getFacilities()
          Gets the value of the facilities property.
 NAServerLocations getIncidents()
          Gets the value of the incidents 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.
 EsriNATravelDirection getTravelDirection()
          Gets the value of the travelDirection property.
 boolean isCreateTraversalResult()
          Gets the value of the createTraversalResult property.
 boolean isReturnBarriers()
          Gets the value of the returnBarriers property.
 boolean isReturnCFRouteGeometries()
          Gets the value of the returnCFRouteGeometries property.
 boolean isReturnCFRoutes()
          Gets the value of the returnCFRoutes property.
 boolean isReturnCompactDirections()
          Gets the value of the returnCompactDirections property.
 boolean isReturnDirections()
          Gets the value of the returnDirections property.
 boolean isReturnFacilities()
          Gets the value of the returnFacilities property.
 boolean isReturnIncidents()
          Gets the value of the returnIncidents property.
 Boolean isReturnPolygonBarriers()
           
 Boolean isReturnPolylineBarriers()
           
 void setBarriers(NAServerLocations value)
          Sets the value of the barriers property.
 void setCreateTraversalResult(boolean value)
          Sets the value of the createTraversalResult property.
 void setDefaultCutoff(Object value)
          Sets the value of the defaultCutoff property.
 void setDefaultTargetFacilityCount(int value)
          Sets the value of the defaultTargetFacilityCount 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 setFacilities(NAServerLocations value)
          Sets the value of the facilities property.
 void setIncidents(NAServerLocations value)
          Sets the value of the incidents 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 setReturnBarriers(boolean value)
          Sets the value of the returnBarriers property.
 void setReturnCFRouteGeometries(boolean value)
          Sets the value of the returnCFRouteGeometries property.
 void setReturnCFRoutes(boolean value)
          Sets the value of the returnCFRoutes property.
 void setReturnCompactDirections(boolean value)
          Sets the value of the returnCompactDirections property.
 void setReturnDirections(boolean value)
          Sets the value of the returnDirections property.
 void setReturnFacilities(boolean value)
          Sets the value of the returnFacilities property.
 void setReturnIncidents(boolean value)
          Sets the value of the returnIncidents property.
 void setReturnPolygonBarriers(Boolean value)
          Sets the value of the returnPolygonBarriers property.
 void setReturnPolylineBarriers(Boolean value)
          Sets the value of the returnPolylineBarriers property.
 void setTravelDirection(EsriNATravelDirection value)
          Sets the value of the travelDirection 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

NAServerClosestFacilityParams

@Deprecated
public NAServerClosestFacilityParams(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 facilities,
                                                NAServerLocations incidents,
                                                NAServerLocations barriers,
                                                boolean returnCFRouteGeometries,
                                                boolean returnCFRoutes,
                                                boolean returnFacilities,
                                                boolean returnIncidents,
                                                boolean returnBarriers,
                                                boolean returnDirections,
                                                String directionsLanguage,
                                                EsriNetworkAttributeUnits directionsLengthUnits,
                                                String directionsTimeAttributeName,
                                                int defaultTargetFacilityCount,
                                                Object defaultCutoff,
                                                EsriNATravelDirection travelDirection,
                                                boolean createTraversalResult,
                                                EsriNAOutputLineType outputLines,
                                                boolean returnCompactDirections,
                                                EsriDirectionsOutputType directionsOutputType,
                                                String directionsStyleName,
                                                NAServerLocations polygonBarriers,
                                                NAServerLocations polylineBarriers,
                                                Boolean returnPolygonBarriers,
                                                Boolean returnPolylineBarriers)
Deprecated. 

NAServerClosestFacilityParams constructor.


NAServerClosestFacilityParams

public NAServerClosestFacilityParams()
NAServerClosestFacilityParams default constructor.

Method Detail

getFacilities

public NAServerLocations getFacilities()
Gets the value of the facilities property.

Returns:
possible object is NAServerLocations

setFacilities

public void setFacilities(NAServerLocations value)
Sets the value of the facilities property.

Parameters:
value - allowed object is NAServerLocations

getIncidents

public NAServerLocations getIncidents()
Gets the value of the incidents property.

Returns:
possible object is NAServerLocations

setIncidents

public void setIncidents(NAServerLocations value)
Sets the value of the incidents 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

isReturnCFRouteGeometries

public boolean isReturnCFRouteGeometries()
Gets the value of the returnCFRouteGeometries property.


setReturnCFRouteGeometries

public void setReturnCFRouteGeometries(boolean value)
Sets the value of the returnCFRouteGeometries property.


isReturnCFRoutes

public boolean isReturnCFRoutes()
Gets the value of the returnCFRoutes property.


setReturnCFRoutes

public void setReturnCFRoutes(boolean value)
Sets the value of the returnCFRoutes property.


isReturnFacilities

public boolean isReturnFacilities()
Gets the value of the returnFacilities property.


setReturnFacilities

public void setReturnFacilities(boolean value)
Sets the value of the returnFacilities property.


isReturnIncidents

public boolean isReturnIncidents()
Gets the value of the returnIncidents property.


setReturnIncidents

public void setReturnIncidents(boolean value)
Sets the value of the returnIncidents 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

getDefaultTargetFacilityCount

public int getDefaultTargetFacilityCount()
Gets the value of the defaultTargetFacilityCount property.


setDefaultTargetFacilityCount

public void setDefaultTargetFacilityCount(int value)
Sets the value of the defaultTargetFacilityCount property.


getDefaultCutoff

public Object getDefaultCutoff()
Gets the value of the defaultCutoff property.

Returns:
possible object is Object

setDefaultCutoff

public void setDefaultCutoff(Object value)
Sets the value of the defaultCutoff property.

Parameters:
value - allowed object is Object

getTravelDirection

public EsriNATravelDirection getTravelDirection()
Gets the value of the travelDirection property.

Returns:
possible object is EsriNATravelDirection

setTravelDirection

public void setTravelDirection(EsriNATravelDirection value)
Sets the value of the travelDirection property.

Parameters:
value - allowed object is EsriNATravelDirection

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

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