com.esri.arcgis.datasourcesnetCDF
Class NetCDFFeatureClassName

java.lang.Object
  com.esri.arcgis.datasourcesnetCDF.NetCDFFeatureClassName

All Implemented Interfaces:

IMDDatasetView, IMDFeatureClassView, IDatasetName, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, Externalizable, Serializable

public class NetCDFFeatureClassName
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, IDatasetName, IPersistStream, IMDDatasetView, IMDFeatureClassView, Externalizable

A container for name information about a NetCDF feature class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

NetCDFFeatureClassName()
Constructs a NetCDFFeatureClassName using ArcGIS Engine.

NetCDFFeatureClassName(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetCDFFeatureClassName theNetCDFFeatureClassName = (NetCDFFeatureClassName) obj;

Method Summary

void	clearSelectedDimensions() Clears a selected list of dimensions and values/indices.
boolean	equals(Object o) Compare this object with another
String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getDimensionIndex(String dim) The selected dimension index for a dimension name.
IStringArray	getDimensions() All dimensions which may be used to select values/indices.
Object	getDimensionValue(String dim) The selected dimension value for a dimension name.
String	getMItem() The M variable or dimension item used.
String	getName() The name of the dataset.
String	getNameString() The name string of the object.
IStringArray	getRowDimensionList() The list of row dimensions used.
ILongArray	getSelectedDimensionIndices() Indices for the values of selected dimensions.
IStringArray	getSelectedDimensions() The selected dimension names.
IVariantArray	getSelectedDimensionValues() The selected dimension values.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IEnumDatasetName	getSubsetNames() Subset names contained within this dataset name.
int	getType() The type of the dataset.
IStringArray	getVariableList() The list of variables used.
IWorkspaceName	getWorkspaceName() The WorkspaceName of the DatasetName.
String	getXDimension() The x-dimension item used.
String	getYDimension() The y-dimension item used.
String	getZItem() The Z variable or dimension item used.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
Object	open() Opens the object referred to by this name.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	selectDimensionByIndex(String dim, int index) Selects the dimension for viewing by an index.
void	selectDimensionByValue(String dim, Object vValue) Selects the dimension for viewing by a value.
void	setCategory(String category) The category of the dataset.
void	setMItem(String pMItem) The M variable or dimension item used.
void	setName(String name) The name of the dataset.
void	setNameString(String nameString) The name string of the object.
void	setRowDimensionList(IStringArray ppRowDims) The list of row dimensions used.
void	setVariableList(IStringArray ppVars) The list of variables used.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The WorkspaceName of the DatasetName.
void	setXDimension(String pXDim) The x-dimension item used.
void	setYDimension(String pYDim) The y-dimension item used.
void	setZItem(String pZItem) The Z variable or dimension item used.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

NetCDFFeatureClassName

public NetCDFFeatureClassName()
                       throws IOException,
                              UnknownHostException

Constructs a NetCDFFeatureClassName using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NetCDFFeatureClassName

public NetCDFFeatureClassName(Object obj)
                       throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setNameString

public void setNameString(String nameString)
                   throws IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws IOException,
                   AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IDatasetName

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The name of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IDatasetName

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IDatasetName

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IDatasetName

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(String category)
                 throws IOException,
                        AutomationException

The category of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCategory in interface IDatasetName

Parameters:

category - The category (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException

The WorkspaceName of the DatasetName.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceName in interface IDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws IOException,
                                  AutomationException

The WorkspaceName of the DatasetName.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWorkspaceNameByRef in interface IDatasetName

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubsetNames

public IEnumDatasetName getSubsetNames()
                                throws IOException,
                                       AutomationException

Subset names contained within this dataset name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSubsetNames in interface IDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectDimensionByValue

public void selectDimensionByValue(String dim,
                                   Object vValue)
                            throws IOException,
                                   AutomationException

Selects the dimension for viewing by a value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

selectDimensionByValue in interface IMDDatasetView

Parameters:

dim - The dim (in)

vValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectDimensionByIndex

public void selectDimensionByIndex(String dim,
                                   int index)
                            throws IOException,
                                   AutomationException

Selects the dimension for viewing by an index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

selectDimensionByIndex in interface IMDDatasetView

Parameters:

dim - The dim (in)

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionValue

public Object getDimensionValue(String dim)
                         throws IOException,
                                AutomationException

The selected dimension value for a dimension name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDimensionValue in interface IMDDatasetView

Parameters:

dim - The dim (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionIndex

public int getDimensionIndex(String dim)
                      throws IOException,
                             AutomationException

The selected dimension index for a dimension name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDimensionIndex in interface IMDDatasetView

Parameters:

dim - The dim (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedDimensions

public IStringArray getSelectedDimensions()
                                   throws IOException,
                                          AutomationException

The selected dimension names.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSelectedDimensions in interface IMDDatasetView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedDimensionValues

public IVariantArray getSelectedDimensionValues()
                                         throws IOException,
                                                AutomationException

The selected dimension values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSelectedDimensionValues in interface IMDDatasetView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedDimensionIndices

public ILongArray getSelectedDimensionIndices()
                                       throws IOException,
                                              AutomationException

Indices for the values of selected dimensions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSelectedDimensionIndices in interface IMDDatasetView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearSelectedDimensions

public void clearSelectedDimensions()
                             throws IOException,
                                    AutomationException

Clears a selected list of dimensions and values/indices.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

clearSelectedDimensions in interface IMDDatasetView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensions

public IStringArray getDimensions()
                           throws IOException,
                                  AutomationException

All dimensions which may be used to select values/indices.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDimensions in interface IMDDatasetView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVariableList

public IStringArray getVariableList()
                             throws IOException,
                                    AutomationException

The list of variables used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getVariableList in interface IMDFeatureClassView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVariableList

public void setVariableList(IStringArray ppVars)
                     throws IOException,
                            AutomationException

The list of variables used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setVariableList in interface IMDFeatureClassView

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXDimension

public String getXDimension()
                     throws IOException,
                            AutomationException

The x-dimension item used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getXDimension in interface IMDFeatureClassView

Returns:

The pXDim

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXDimension

public void setXDimension(String pXDim)
                   throws IOException,
                          AutomationException

The x-dimension item used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setXDimension in interface IMDFeatureClassView

Parameters:

pXDim - The pXDim (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYDimension

public String getYDimension()
                     throws IOException,
                            AutomationException

The y-dimension item used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getYDimension in interface IMDFeatureClassView

Returns:

The pYDim

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYDimension

public void setYDimension(String pYDim)
                   throws IOException,
                          AutomationException

The y-dimension item used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setYDimension in interface IMDFeatureClassView

Parameters:

pYDim - The pYDim (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowDimensionList

public IStringArray getRowDimensionList()
                                 throws IOException,
                                        AutomationException

The list of row dimensions used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getRowDimensionList in interface IMDFeatureClassView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRowDimensionList

public void setRowDimensionList(IStringArray ppRowDims)
                         throws IOException,
                                AutomationException

The list of row dimensions used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setRowDimensionList in interface IMDFeatureClassView

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZItem

public String getZItem()
                throws IOException,
                       AutomationException

The Z variable or dimension item used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getZItem in interface IMDFeatureClassView

Returns:

The pZItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZItem

public void setZItem(String pZItem)
              throws IOException,
                     AutomationException

The Z variable or dimension item used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setZItem in interface IMDFeatureClassView

Parameters:

pZItem - The pZItem (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMItem

public String getMItem()
                throws IOException,
                       AutomationException

The M variable or dimension item used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getMItem in interface IMDFeatureClassView

Returns:

The pMItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMItem

public void setMItem(String pMItem)
              throws IOException,
                     AutomationException

The M variable or dimension item used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setMItem in interface IMDFeatureClassView

Parameters:

pMItem - The pMItem (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException