com.esri.arcgis.networkanalyst
Class NAClassFieldMap

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

All Implemented Interfaces:

IGPValue, com.esri.arcgis.interop.RemoteObjRef, INAClassFieldMap, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class NAClassFieldMap
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INAClassFieldMap, IGPValue, IClone, IPersistStream, IXMLSerialize, java.io.Externalizable

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

Description 'Defines one field mapping.' 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.INAClassFieldMap

IID, IIDcab2ff06_6d86_405d_982f_6f30f3bc58ac, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue

IID, IID92ee08b6_c757_4178_803c_67cd665ac801, 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

NAClassFieldMap()
Constructs a NAClassFieldMap using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	createMapping(INAClassDefinition classDef, IFields fields) Creates a new field name mapping.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	empty() Clears the value object.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
java.lang.String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getCount() The count of field mappings defined.
java.lang.Object	getDefaultValue(java.lang.String fieldName) The default field value for a given input field name.
java.lang.String	getFieldName(int index) The mapping for the given index.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMappedField(java.lang.String fieldName) The output field name mapped to a given input field name.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
void	isDirty() isDirty
boolean	isEmpty() Indicates if the value object is empty.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a NAClassFieldMap.
void	remove(java.lang.String fieldName) Removes the entry for an existing field name mapping.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(java.lang.String text) Provides the value of the value object with the given string value.
void	setDefaultValue(java.lang.String fieldName, java.lang.Object value) The default field value for a given input field name.
void	setMappedField(java.lang.String fieldName, java.lang.String mappedField) The output field name mapped to a given input field name.
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

NAClassFieldMap

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

Constructs a NAClassFieldMap using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NAClassFieldMap

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

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

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

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 NAClassFieldMap.

Specified by:

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

setMappedField

public void setMappedField(java.lang.String fieldName,
                           java.lang.String mappedField)
                    throws java.io.IOException,
                           AutomationException

The output field name mapped to a given input field name.

Specified by:

setMappedField in interface INAClassFieldMap

Parameters:

fieldName - The fieldName (in)

mappedField - The mappedField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMappedField

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

The output field name mapped to a given input field name.

Specified by:

getMappedField in interface INAClassFieldMap

Parameters:

fieldName - The fieldName (in)

Returns:

The mappedField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultValue

public void setDefaultValue(java.lang.String fieldName,
                            java.lang.Object value)
                     throws java.io.IOException,
                            AutomationException

The default field value for a given input field name.

Specified by:

setDefaultValue in interface INAClassFieldMap

Parameters:

fieldName - The fieldName (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

public java.lang.Object getDefaultValue(java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException

The default field value for a given input field name.

Specified by:

getDefaultValue in interface INAClassFieldMap

Parameters:

fieldName - The fieldName (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(java.lang.String fieldName)
            throws java.io.IOException,
                   AutomationException

Removes the entry for an existing field name mapping.

Specified by:

remove in interface INAClassFieldMap

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createMapping

public void createMapping(INAClassDefinition classDef,
                          IFields fields)
                   throws java.io.IOException,
                          AutomationException

Creates a new field name mapping.

Specified by:

createMapping in interface INAClassFieldMap

Parameters:

classDef - A reference to a com.esri.arcgis.networkanalyst.INAClassDefinition (in)

fields - 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.

getCount

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

The count of field mappings defined.

Specified by:

getCount in interface INAClassFieldMap

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldName

public java.lang.String getFieldName(int index)
                              throws java.io.IOException,
                                     AutomationException

The mapping for the given index.

Specified by:

getFieldName in interface INAClassFieldMap

Parameters:

index - The index (in)

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException

The data type of the value object.

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEmpty

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

Indicates if the value object is empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

empty

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

Clears the value object.

Specified by:

empty in interface IGPValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsText

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

Provides the value of the value object.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

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