com.esri.arcgisws
Class NAServerSolverParams

java.lang.Object
  extended by com.esri.arcgisws.NAServerSolverParams
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
NAServerClosestFacilityParams, NAServerLocationAllocationParams, NAServerODCostMatrixParams, NAServerRouteParams, NAServerServiceAreaParams, NAServerVRPParams

public abstract class NAServerSolverParams
extends Object
implements Serializable

Java class for NAServerSolverParams complex type.

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

 <complexType name="NAServerSolverParams">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="NALayerName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SnapTolerance" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="MaxSnapTolerance" type="{http://www.w3.org/2001/XMLSchema}double"/>
         <element name="SnapToleranceUnits" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriUnits"/>
         <element name="NAClassCandidateFieldMaps" type="{http://www.esri.com/schemas/ArcGIS/10.0}ArrayOfNAClassCandidateFieldMap"/>
         <element name="ReturnMap" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="MapDescription" type="{http://www.esri.com/schemas/ArcGIS/10.0}MapDescription" minOccurs="0"/>
         <element name="ImageDescription" type="{http://www.esri.com/schemas/ArcGIS/10.0}ImageDescription" minOccurs="0"/>
         <element name="OutputSpatialReference" type="{http://www.esri.com/schemas/ArcGIS/10.0}SpatialReference" minOccurs="0"/>
         <element name="ReturnGeometriesAsBinary" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="AccumulateAttributeNames" type="{http://www.esri.com/schemas/ArcGIS/10.0}ArrayOfString" minOccurs="0"/>
         <element name="ImpedanceAttributeName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="IgnoreInvalidLocations" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="RestrictUTurns" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriNetworkForwardStarBacktrack"/>
         <element name="RestrictionAttributeNames" type="{http://www.esri.com/schemas/ArcGIS/10.0}ArrayOfString" minOccurs="0"/>
         <element name="UseHierarchy" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="HierarchyAttributeName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="HierarchyLevelCount" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="HierarchyMaxValues" type="{http://www.esri.com/schemas/ArcGIS/10.0}ArrayOfInt" minOccurs="0"/>
         <element name="HierarchyNumTransitions" type="{http://www.esri.com/schemas/ArcGIS/10.0}ArrayOfInt" minOccurs="0"/>
         <element name="ResetHierarchyRangesOnBind" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="AttributeParameterValues" type="{http://www.esri.com/schemas/ArcGIS/10.0}ArrayOfNAAttributeParameterValue" minOccurs="0"/>
         <element name="OutputGeometryPrecision" type="{http://www.w3.org/2001/XMLSchema}anyType" minOccurs="0"/>
         <element name="OutputGeometryPrecisionUnits" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriUnits" minOccurs="0"/>
         <element name="ReturnPartialResultsOnError" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="SaveLayerOnServer" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="LayerToken" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:
Serialized Form

Constructor Summary
NAServerSolverParams()
          NAServerSolverParams default constructor.
NAServerSolverParams(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)
          Deprecated. 
 
Method Summary
 String[] getAccumulateAttributeNames()
          Gets the value of the accumulateAttributeNames property.
 NAAttributeParameterValue[] getAttributeParameterValues()
          Gets the value of the attributeParameterValues property.
 String getHierarchyAttributeName()
          Gets the value of the hierarchyAttributeName property.
 int getHierarchyLevelCount()
          Gets the value of the hierarchyLevelCount property.
 int[] getHierarchyMaxValues()
          Gets the value of the hierarchyMaxValues property.
 int[] getHierarchyNumTransitions()
          Gets the value of the hierarchyNumTransitions property.
 ImageDescription getImageDescription()
          Gets the value of the imageDescription property.
 String getImpedanceAttributeName()
          Gets the value of the impedanceAttributeName property.
 String getLayerToken()
          Gets the value of the layerToken property.
 MapDescription getMapDescription()
          Gets the value of the mapDescription property.
 double getMaxSnapTolerance()
          Gets the value of the maxSnapTolerance property.
 NAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
          Gets the value of the naClassCandidateFieldMaps property.
 String getNALayerName()
          Gets the value of the naLayerName property.
 Object getOutputGeometryPrecision()
          Specifies the precision of the output geometry after generalization.
 EsriUnits getOutputGeometryPrecisionUnits()
          Specifies the units of the output geometry precision.
 SpatialReference getOutputSpatialReference()
          Gets the value of the outputSpatialReference property.
 String[] getRestrictionAttributeNames()
          Gets the value of the restrictionAttributeNames property.
 EsriNetworkForwardStarBacktrack getRestrictUTurns()
          Gets the value of the restrictUTurns property.
 Boolean getReturnPartialResultsOnError()
          Gets the value of the returnPartialResultsOnError property.
 Boolean getSaveLayerOnServer()
          Gets the value of the saveLayerOnServer property.
 double getSnapTolerance()
          Gets the value of the snapTolerance property.
 EsriUnits getSnapToleranceUnits()
          Gets the value of the snapToleranceUnits property.
 boolean isIgnoreInvalidLocations()
          Gets the value of the ignoreInvalidLocations property.
 boolean isResetHierarchyRangesOnBind()
          Gets the value of the resetHierarchyRangesOnBind property.
 boolean isReturnGeometriesAsBinary()
          Gets the value of the returnGeometriesAsBinary property.
 boolean isReturnMap()
          Gets the value of the returnMap property.
 Boolean isReturnPartialResultsOnError()
           
 Boolean isSaveLayerOnServer()
           
 boolean isUseHierarchy()
          Gets the value of the useHierarchy property.
 void setAccumulateAttributeNames(String[] value)
          Sets the value of the accumulateAttributeNames property.
 void setAttributeParameterValues(NAAttributeParameterValue[] value)
          Sets the value of the attributeParameterValues property.
 void setHierarchyAttributeName(String value)
          Sets the value of the hierarchyAttributeName property.
 void setHierarchyLevelCount(int value)
          Sets the value of the hierarchyLevelCount property.
 void setHierarchyMaxValues(int[] value)
          Sets the value of the hierarchyMaxValues property.
 void setHierarchyNumTransitions(int[] value)
          Sets the value of the hierarchyNumTransitions property.
 void setIgnoreInvalidLocations(boolean value)
          Sets the value of the ignoreInvalidLocations property.
 void setImageDescription(ImageDescription value)
          Sets the value of the imageDescription property.
 void setImpedanceAttributeName(String value)
          Sets the value of the impedanceAttributeName property.
 void setLayerToken(String value)
          Sets the value of the layerToken property.
 void setMapDescription(MapDescription value)
          Sets the value of the mapDescription property.
 void setMaxSnapTolerance(double value)
          Sets the value of the maxSnapTolerance property.
 void setNAClassCandidateFieldMaps(NAClassCandidateFieldMap[] value)
          Sets the value of the naClassCandidateFieldMaps property.
 void setNALayerName(String value)
          Sets the value of the naLayerName property.
 void setOutputGeometryPrecision(Object value)
          Specifies the precision of the output geometry after generalization.
 void setOutputGeometryPrecisionUnits(EsriUnits value)
          Specifies the units of the output geometry precision.
 void setOutputSpatialReference(SpatialReference value)
          Sets the value of the outputSpatialReference property.
 void setResetHierarchyRangesOnBind(boolean value)
          Sets the value of the resetHierarchyRangesOnBind property.
 void setRestrictionAttributeNames(String[] value)
          Sets the value of the restrictionAttributeNames property.
 void setRestrictUTurns(EsriNetworkForwardStarBacktrack value)
          Sets the value of the restrictUTurns property.
 void setReturnGeometriesAsBinary(boolean value)
          Sets the value of the returnGeometriesAsBinary property.
 void setReturnMap(boolean value)
          Sets the value of the returnMap property.
 void setReturnPartialResultsOnError(Boolean value)
          Sets the value of the returnPartialResultsOnError property.
 void setSaveLayerOnServer(Boolean value)
          Sets the value of the saveLayerOnServer property.
 void setSnapTolerance(double value)
          Sets the value of the snapTolerance property.
 void setSnapToleranceUnits(EsriUnits value)
          Sets the value of the snapToleranceUnits property.
 void setUseHierarchy(boolean value)
          Sets the value of the useHierarchy property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NAServerSolverParams

@Deprecated
public NAServerSolverParams(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)
Deprecated. 

NAServerSolverParams constructor.


NAServerSolverParams

public NAServerSolverParams()
NAServerSolverParams default constructor.

Method Detail

getNALayerName

public String getNALayerName()
Gets the value of the naLayerName property.

Returns:
possible object is String

setNALayerName

public void setNALayerName(String value)
Sets the value of the naLayerName property.

Parameters:
value - allowed object is String

getSnapTolerance

public double getSnapTolerance()
Gets the value of the snapTolerance property.


setSnapTolerance

public void setSnapTolerance(double value)
Sets the value of the snapTolerance property.


getMaxSnapTolerance

public double getMaxSnapTolerance()
Gets the value of the maxSnapTolerance property.


setMaxSnapTolerance

public void setMaxSnapTolerance(double value)
Sets the value of the maxSnapTolerance property.


getSnapToleranceUnits

public EsriUnits getSnapToleranceUnits()
Gets the value of the snapToleranceUnits property.

Returns:
possible object is EsriUnits

setSnapToleranceUnits

public void setSnapToleranceUnits(EsriUnits value)
Sets the value of the snapToleranceUnits property.

Parameters:
value - allowed object is EsriUnits

getNAClassCandidateFieldMaps

public NAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
Gets the value of the naClassCandidateFieldMaps property.

Returns:
possible object is []

setNAClassCandidateFieldMaps

public void setNAClassCandidateFieldMaps(NAClassCandidateFieldMap[] value)
Sets the value of the naClassCandidateFieldMaps property.

Parameters:
value - allowed object is []

isReturnMap

public boolean isReturnMap()
Gets the value of the returnMap property.


setReturnMap

public void setReturnMap(boolean value)
Sets the value of the returnMap property.


getMapDescription

public MapDescription getMapDescription()
Gets the value of the mapDescription property.

Returns:
possible object is MapDescription

setMapDescription

public void setMapDescription(MapDescription value)
Sets the value of the mapDescription property.

Parameters:
value - allowed object is MapDescription

getImageDescription

public ImageDescription getImageDescription()
Gets the value of the imageDescription property.

Returns:
possible object is ImageDescription

setImageDescription

public void setImageDescription(ImageDescription value)
Sets the value of the imageDescription property.

Parameters:
value - allowed object is ImageDescription

getOutputSpatialReference

public SpatialReference getOutputSpatialReference()
Gets the value of the outputSpatialReference property.

Returns:
possible object is SpatialReference

setOutputSpatialReference

public void setOutputSpatialReference(SpatialReference value)
Sets the value of the outputSpatialReference property.

Parameters:
value - allowed object is SpatialReference

isReturnGeometriesAsBinary

public boolean isReturnGeometriesAsBinary()
Gets the value of the returnGeometriesAsBinary property.


setReturnGeometriesAsBinary

public void setReturnGeometriesAsBinary(boolean value)
Sets the value of the returnGeometriesAsBinary property.


getAccumulateAttributeNames

public String[] getAccumulateAttributeNames()
Gets the value of the accumulateAttributeNames property.

Returns:
possible object is []

setAccumulateAttributeNames

public void setAccumulateAttributeNames(String[] value)
Sets the value of the accumulateAttributeNames property.

Parameters:
value - allowed object is []

getImpedanceAttributeName

public String getImpedanceAttributeName()
Gets the value of the impedanceAttributeName property.

Returns:
possible object is String

setImpedanceAttributeName

public void setImpedanceAttributeName(String value)
Sets the value of the impedanceAttributeName property.

Parameters:
value - allowed object is String

isIgnoreInvalidLocations

public boolean isIgnoreInvalidLocations()
Gets the value of the ignoreInvalidLocations property.


setIgnoreInvalidLocations

public void setIgnoreInvalidLocations(boolean value)
Sets the value of the ignoreInvalidLocations property.


getRestrictUTurns

public EsriNetworkForwardStarBacktrack getRestrictUTurns()
Gets the value of the restrictUTurns property.

Returns:
possible object is EsriNetworkForwardStarBacktrack

setRestrictUTurns

public void setRestrictUTurns(EsriNetworkForwardStarBacktrack value)
Sets the value of the restrictUTurns property.

Parameters:
value - allowed object is EsriNetworkForwardStarBacktrack

getRestrictionAttributeNames

public String[] getRestrictionAttributeNames()
Gets the value of the restrictionAttributeNames property.

Returns:
possible object is []

setRestrictionAttributeNames

public void setRestrictionAttributeNames(String[] value)
Sets the value of the restrictionAttributeNames property.

Parameters:
value - allowed object is []

isUseHierarchy

public boolean isUseHierarchy()
Gets the value of the useHierarchy property.


setUseHierarchy

public void setUseHierarchy(boolean value)
Sets the value of the useHierarchy property.


getHierarchyAttributeName

public String getHierarchyAttributeName()
Gets the value of the hierarchyAttributeName property.

Returns:
possible object is String

setHierarchyAttributeName

public void setHierarchyAttributeName(String value)
Sets the value of the hierarchyAttributeName property.

Parameters:
value - allowed object is String

getHierarchyLevelCount

public int getHierarchyLevelCount()
Gets the value of the hierarchyLevelCount property.


setHierarchyLevelCount

public void setHierarchyLevelCount(int value)
Sets the value of the hierarchyLevelCount property.


getHierarchyMaxValues

public int[] getHierarchyMaxValues()
Gets the value of the hierarchyMaxValues property.

Returns:
possible object is []

setHierarchyMaxValues

public void setHierarchyMaxValues(int[] value)
Sets the value of the hierarchyMaxValues property.

Parameters:
value - allowed object is []

getHierarchyNumTransitions

public int[] getHierarchyNumTransitions()
Gets the value of the hierarchyNumTransitions property.

Returns:
possible object is []

setHierarchyNumTransitions

public void setHierarchyNumTransitions(int[] value)
Sets the value of the hierarchyNumTransitions property.

Parameters:
value - allowed object is []

isResetHierarchyRangesOnBind

public boolean isResetHierarchyRangesOnBind()
Gets the value of the resetHierarchyRangesOnBind property.


setResetHierarchyRangesOnBind

public void setResetHierarchyRangesOnBind(boolean value)
Sets the value of the resetHierarchyRangesOnBind property.


getAttributeParameterValues

public NAAttributeParameterValue[] getAttributeParameterValues()
Gets the value of the attributeParameterValues property.

Returns:
possible object is []

setAttributeParameterValues

public void setAttributeParameterValues(NAAttributeParameterValue[] value)
Sets the value of the attributeParameterValues property.

Parameters:
value - allowed object is []

getOutputGeometryPrecision

public Object getOutputGeometryPrecision()
Specifies the precision of the output geometry after generalization. Gets the value of the outputGeometryPrecision property.

Returns:
possible object is Object

setOutputGeometryPrecision

public void setOutputGeometryPrecision(Object value)
Specifies the precision of the output geometry after generalization. Sets the value of the outputGeometryPrecision property.

Parameters:
value - allowed object is Object

getOutputGeometryPrecisionUnits

public EsriUnits getOutputGeometryPrecisionUnits()
Specifies the units of the output geometry precision. Gets the value of the outputGeometryPrecisionUnits property.

Returns:
possible object is EsriUnits

setOutputGeometryPrecisionUnits

public void setOutputGeometryPrecisionUnits(EsriUnits value)
Specifies the units of the output geometry precision. Sets the value of the outputGeometryPrecisionUnits property.

Parameters:
value - allowed object is EsriUnits

getReturnPartialResultsOnError

public Boolean getReturnPartialResultsOnError()
Gets the value of the returnPartialResultsOnError property.

Returns:
possible object is Boolean

isReturnPartialResultsOnError

public Boolean isReturnPartialResultsOnError()

setReturnPartialResultsOnError

public void setReturnPartialResultsOnError(Boolean value)
Sets the value of the returnPartialResultsOnError property.

Parameters:
value - allowed object is Boolean

getSaveLayerOnServer

public Boolean getSaveLayerOnServer()
Gets the value of the saveLayerOnServer property.

Returns:
possible object is Boolean

isSaveLayerOnServer

public Boolean isSaveLayerOnServer()

setSaveLayerOnServer

public void setSaveLayerOnServer(Boolean value)
Sets the value of the saveLayerOnServer property.

Parameters:
value - allowed object is Boolean

getLayerToken

public String getLayerToken()
Gets the value of the layerToken property.

Returns:
possible object is String

setLayerToken

public void setLayerToken(String value)
Sets the value of the layerToken property.

Parameters:
value - allowed object is String