com.esri.arcgis.datasourcesraster
Class FunctionRasterDatasetName

java.lang.Object
  com.esri.arcgis.datasourcesraster.FunctionRasterDatasetName

All Implemented Interfaces:

IFunctionRasterDatasetName, IRasterKeyProperties, IDatasetName, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class FunctionRasterDatasetName
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, IDatasetName, IFunctionRasterDatasetName, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, IRasterKeyProperties, Externalizable

A class for a function raster dataset name.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

FunctionRasterDatasetName()
Constructs a FunctionRasterDatasetName using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getAllBandProperties(int bandIndex, IStringArray[] ppNames, IVariantArray[] ppValues) Queries all available band-specific key properties.
void	getAllProperties(IStringArray[] ppNames, IVariantArray[] ppValues) Queries all available key properties.
Object	getArguments() The raster function argument(s).
Object	getBandProperty(String sName, int bandIndex) Returns the requested key property by name for a given band.
String	getBrowseName() The browse name.
String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getFullName() The full path name.
IRasterFunction	getFunction() The raster function.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
String	getName() The name of the dataset.
String	getNameString() The name string of the object.
IPropertySet	getProperties() The function raster dataset proprties.
Object	getProperty(String sName) Returns the requested key property by name.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IEnumDatasetName	getSubsetNames() Subset names contained within this dataset name.
int	getType() The type of the dataset.
IWorkspaceName	getWorkspaceName() The WorkspaceName of the DatasetName.
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	removeBandProperty(String sName, int bandIndex) Removes all occurrences of the specified key property for a given band.
void	removeProperty(String sName) Removes all occurrences of the specified key property.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setArgumentsByRef(Object ppArguments) The raster function argument(s).
void	setBandProperty(String sName, int bandIndex, Object vtValue) Updates the value of the specified key property by name for a given band.
void	setBrowseName(String pName) The browse name.
void	setCategory(String category) The category of the dataset.
void	setFullName(String pName) The full path name.
void	setFunctionByRef(IRasterFunction ppFunction) The raster function.
void	setName(String name) The name of the dataset.
void	setNameString(String nameString) The name string of the object.
void	setPropertiesByRef(IPropertySet ppProperties) The function raster dataset proprties.
void	setProperty(String sName, Object vtValue) Updates the value of the specified key property by name.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The WorkspaceName of the DatasetName.
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

FunctionRasterDatasetName

public FunctionRasterDatasetName()
                          throws IOException,
                                 UnknownHostException

Constructs a FunctionRasterDatasetName using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FunctionRasterDatasetName

public FunctionRasterDatasetName(Object obj)
                          throws IOException

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

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

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.

setFullName

public void setFullName(String pName)
                 throws IOException,
                        AutomationException

The full path name.

Product Availability

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

Specified by:

setFullName in interface IFunctionRasterDatasetName

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public String getFullName()
                   throws IOException,
                          AutomationException

The full path name.

Product Availability

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

Specified by:

getFullName in interface IFunctionRasterDatasetName

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFunction

public IRasterFunction getFunction()
                            throws IOException,
                                   AutomationException

The raster function.

Product Availability

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

Specified by:

getFunction in interface IFunctionRasterDatasetName

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFunctionByRef

public void setFunctionByRef(IRasterFunction ppFunction)
                      throws IOException,
                             AutomationException

The raster function.

Product Availability

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

Specified by:

setFunctionByRef in interface IFunctionRasterDatasetName

Parameters:

ppFunction - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArguments

public Object getArguments()
                    throws IOException,
                           AutomationException

The raster function argument(s).

Product Availability

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

Specified by:

getArguments in interface IFunctionRasterDatasetName

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArgumentsByRef

public void setArgumentsByRef(Object ppArguments)
                       throws IOException,
                              AutomationException

The raster function argument(s).

Product Availability

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

Specified by:

setArgumentsByRef in interface IFunctionRasterDatasetName

Parameters:

ppArguments - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

public void setPropertiesByRef(IPropertySet ppProperties)
                        throws IOException,
                               AutomationException

The function raster dataset proprties.

Product Availability

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

Specified by:

setPropertiesByRef in interface IFunctionRasterDatasetName

Parameters:

ppProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

The function raster dataset proprties.

Product Availability

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

Specified by:

getProperties in interface IFunctionRasterDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(String pName)
                   throws IOException,
                          AutomationException

The browse name.

Product Availability

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

Specified by:

setBrowseName in interface IFunctionRasterDatasetName

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException

The browse name.

Product Availability

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

Specified by:

getBrowseName in interface IFunctionRasterDatasetName

Returns:

The pName

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.

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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperty

public Object getProperty(String sName)
                   throws IOException,
                          AutomationException

Returns the requested key property by name.

Product Availability

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

Specified by:

getProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(String sName,
                        Object vtValue)
                 throws IOException,
                        AutomationException

Updates the value of the specified key property by name.

Product Availability

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

Specified by:

setProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

vtValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeProperty

public void removeProperty(String sName)
                    throws IOException,
                           AutomationException

Removes all occurrences of the specified key property.

Product Availability

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

Specified by:

removeProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllProperties

public void getAllProperties(IStringArray[] ppNames,
                             IVariantArray[] ppValues)
                      throws IOException,
                             AutomationException

Queries all available key properties.

Product Availability

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

Specified by:

getAllProperties in interface IRasterKeyProperties

Parameters:

ppNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppValues - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandProperty

public Object getBandProperty(String sName,
                              int bandIndex)
                       throws IOException,
                              AutomationException

Returns the requested key property by name for a given band.

Product Availability

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

Specified by:

getBandProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

bandIndex - The bandIndex (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandProperty

public void setBandProperty(String sName,
                            int bandIndex,
                            Object vtValue)
                     throws IOException,
                            AutomationException

Updates the value of the specified key property by name for a given band.

Product Availability

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

Specified by:

setBandProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

bandIndex - The bandIndex (in)

vtValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeBandProperty

public void removeBandProperty(String sName,
                               int bandIndex)
                        throws IOException,
                               AutomationException

Removes all occurrences of the specified key property for a given band.

Product Availability

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

Specified by:

removeBandProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

bandIndex - The bandIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllBandProperties

public void getAllBandProperties(int bandIndex,
                                 IStringArray[] ppNames,
                                 IVariantArray[] ppValues)
                          throws IOException,
                                 AutomationException

Queries all available band-specific key properties.

Product Availability

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

Specified by:

getAllBandProperties in interface IRasterKeyProperties

Parameters:

bandIndex - The bandIndex (in)

ppNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppValues - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)

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