com.esri.arcgis.networkanalyst
Class NAClassDefinition

java.lang.Object
  com.esri.arcgis.networkanalyst.NAClassDefinition

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INAClassDefinition, INAClassDefinition2, INAClassDefinitionEdit, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class NAClassDefinition
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INAClassDefinition, INAClassDefinition2, INAClassDefinitionEdit, IClone, IPersistStream, IXMLSerialize, java.io.Externalizable

COM Class 'NAClassDefinition'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description 'Defines how fields should be mapped as inputs and outputs of analysis functions.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.networkanalyst.INAClassDefinition2

IID, IID9d2e0012_dc44_4458_87a7_2cc46a7dad51, xxDummy

Fields inherited from interface com.esri.arcgis.networkanalyst.INAClassDefinition

IID33bd1554_f6af_408f_bee9_cb8226dfd4ad

Fields inherited from interface com.esri.arcgis.networkanalyst.INAClassDefinitionEdit

IID, IIDa69d3ac5_54f6_4bf0_bbc6_336ba02317ec, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

NAClassDefinition()
Constructs a NAClassDefinition using ArcGIS Engine.

NAClassDefinition(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAClassDefinition theNAClassDefinition = (NAClassDefinition) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
int	findLocationRangesField() The field index of the Location Ranges BLOB field used to store LocationRanges, or -1 if the referenced NAClass does not support NALocationRanges.
IStringArray	getCandidateFieldNames(java.lang.String fieldName) The field names that will be used by default for the network analyst class.
IUID	getClassCLSID() The COM class id for the network analyst class.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IFields	getFields() The fields for the network analyst class.
int	getFieldType(java.lang.String fieldName) The field type for a network analyst class field.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLowerBound() The minimum number of objects required in the class by the solver to perform analysis.
java.lang.String	getName() The name of the class.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getUpperBound() The maximum number of objects allowed in the class by the solver to perform analysis.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isHasLocationFields() Indicates if the class has location fields.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isInput() Indicates if the class is used as an input to analysis.
boolean	isOutput() Indicates if the class is used as an output from analysis.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a NAClassDefinition.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCandidateFieldNamesByRef(java.lang.String fieldName, IStringArray rhs2) The field names that will be used by default for the network analyst class.
void	setClassCLSIDByRef(IUID rhs1) The COM class id for the network analyst class.
void	setFieldsByRef(IFields rhs1) The fields for the network analyst class.
void	setFieldType(java.lang.String fieldName, int rhs2) The field type for a network analyst class field.
void	setIsInput(boolean rhs1) Indicates if the class is used as an input to analysis.
void	setIsOutput(boolean rhs1) Indicates if the class is used as an output from analysis.
void	setLowerBound(int rhs1) The minimum number of objects required in the class by the solver to perform analysis.
void	setName(java.lang.String rhs1) The name of the class.
void	setUpperBound(int rhs1) The maximum number of objects allowed in the class by the solver to perform analysis.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

NAClassDefinition

public NAClassDefinition()
                  throws java.io.IOException,
                         java.net.UnknownHostException

Constructs a NAClassDefinition using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NAClassDefinition

public NAClassDefinition(java.lang.Object obj)
                  throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAClassDefinition theNAClassDefinition = (NAClassDefinition) obj;

Construct a NAClassDefinition using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NAClassDefinition.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a NAClassDefinition.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the class.

Specified by:

getName in interface INAClassDefinition

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassCLSID

public IUID getClassCLSID()
                   throws java.io.IOException,
                          AutomationException

The COM class id for the network analyst class.

Specified by:

getClassCLSID in interface INAClassDefinition

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException

The fields for the network analyst class.

Specified by:

getFields in interface INAClassDefinition

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldType

public int getFieldType(java.lang.String fieldName)
                 throws java.io.IOException,
                        AutomationException

The field type for a network analyst class field.

Specified by:

getFieldType in interface INAClassDefinition

Parameters:

fieldName - The fieldName (in)

Returns:

The naFieldType

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCandidateFieldNames

public IStringArray getCandidateFieldNames(java.lang.String fieldName)
                                    throws java.io.IOException,
                                           AutomationException

The field names that will be used by default for the network analyst class.

Specified by:

getCandidateFieldNames in interface INAClassDefinition

Parameters:

fieldName - The fieldName (in)

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasLocationFields

public boolean isHasLocationFields()
                            throws java.io.IOException,
                                   AutomationException

Indicates if the class has location fields.

Specified by:

isHasLocationFields in interface INAClassDefinition

Returns:

The hasLocationFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLowerBound

public int getLowerBound()
                  throws java.io.IOException,
                         AutomationException

The minimum number of objects required in the class by the solver to perform analysis.

Specified by:

getLowerBound in interface INAClassDefinition

Returns:

The lowerBound

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpperBound

public int getUpperBound()
                  throws java.io.IOException,
                         AutomationException

The maximum number of objects allowed in the class by the solver to perform analysis.

Specified by:

getUpperBound in interface INAClassDefinition

Returns:

The upperBound

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInput

public boolean isInput()
                throws java.io.IOException,
                       AutomationException

Indicates if the class is used as an input to analysis.

Specified by:

isInput in interface INAClassDefinition

Returns:

The isInput

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutput

public boolean isOutput()
                 throws java.io.IOException,
                        AutomationException

Indicates if the class is used as an output from analysis.

Specified by:

isOutput in interface INAClassDefinition

Returns:

The isOutput

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findLocationRangesField

public int findLocationRangesField()
                            throws java.io.IOException,
                                   AutomationException

The field index of the Location Ranges BLOB field used to store LocationRanges, or -1 if the referenced NAClass does not support NALocationRanges.

Specified by:

findLocationRangesField in interface INAClassDefinition2

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String rhs1)
             throws java.io.IOException,
                    AutomationException

The name of the class.

Specified by:

setName in interface INAClassDefinitionEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassCLSIDByRef

public void setClassCLSIDByRef(IUID rhs1)
                        throws java.io.IOException,
                               AutomationException

The COM class id for the network analyst class.

Specified by:

setClassCLSIDByRef in interface INAClassDefinitionEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldsByRef

public void setFieldsByRef(IFields rhs1)
                    throws java.io.IOException,
                           AutomationException

The fields for the network analyst class.

Specified by:

setFieldsByRef in interface INAClassDefinitionEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldType

public void setFieldType(java.lang.String fieldName,
                         int rhs2)
                  throws java.io.IOException,
                         AutomationException

The field type for a network analyst class field.

Specified by:

setFieldType in interface INAClassDefinitionEdit

Parameters:

fieldName - The fieldName (in)

rhs2 - The rhs2 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCandidateFieldNamesByRef

public void setCandidateFieldNamesByRef(java.lang.String fieldName,
                                        IStringArray rhs2)
                                 throws java.io.IOException,
                                        AutomationException

The field names that will be used by default for the network analyst class.

Specified by:

setCandidateFieldNamesByRef in interface INAClassDefinitionEdit

Parameters:

fieldName - The fieldName (in)

rhs2 - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLowerBound

public void setLowerBound(int rhs1)
                   throws java.io.IOException,
                          AutomationException

The minimum number of objects required in the class by the solver to perform analysis.

Specified by:

setLowerBound in interface INAClassDefinitionEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpperBound

public void setUpperBound(int rhs1)
                   throws java.io.IOException,
                          AutomationException

The maximum number of objects allowed in the class by the solver to perform analysis.

Specified by:

setUpperBound in interface INAClassDefinitionEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsInput

public void setIsInput(boolean rhs1)
                throws java.io.IOException,
                       AutomationException

Indicates if the class is used as an input to analysis.

Specified by:

setIsInput in interface INAClassDefinitionEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsOutput

public void setIsOutput(boolean rhs1)
                 throws java.io.IOException,
                        AutomationException

Indicates if the class is used as an output from analysis.

Specified by:

setIsOutput in interface INAClassDefinitionEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException