com.esri.arcgis.datasourcesraster
Class RasterWorkspace

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

All Implemented Interfaces:

IRasterWorkspace, IRasterWorkspace3, IDataset, IRasterWorkspace2, IWorkspace, IWorkspaceProperties, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class RasterWorkspace
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspace, IRasterWorkspace, IRasterWorkspace2, IRasterWorkspace3, IDataset, ISupportErrorInfo, IWorkspaceProperties

COM Class 'RasterWorkspace'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'The raster workspace object.' 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

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

IID, IIDd4803ee1_79f4_11d0_97fc_0080c7f79481, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterWorkspace

IID, IIDaae25031_35fb_11d2_b1f2_00c04f8edeff, xxDummy

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

IID, IID9fd9a370_1d1b_11d4_abda_0008c73fca1c, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterWorkspace3

IID, IID8ff5ce38_bfe5_4cc7_a76c_da1564b560d1, xxDummy

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

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

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

IID, IID0f1b2257_e2d8_4046_b749_7ff1b058a943, xxDummy

Constructor Summary

RasterWorkspace(java.lang.Object obj)
Construct a RasterWorkspace using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	canCopy() Indicates if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
IDataset	copy(java.lang.String copyName, IWorkspace copyWorkspace) Copies this workspace to a new workspace with the specified name.
IRasterDataset	createRasterDataset(java.lang.String name, java.lang.String format, IPoint origin, int columnCount, int rowCount, double cellSizeX, double cellSizeY, int numBands, int pixelType, ISpatialReference spatialReference, boolean permanent) Creates a RasterDataset in the workspace given its name.
void	delete() Deletes this dataset.
boolean	equals(java.lang.Object o) Compare this object with another
void	executeSQL(java.lang.String sqlStmt) Executes the specified SQL statement.
boolean	exists() Checks if the workspace exists.
java.lang.String	getBrowseName() The browse name of the dataset.
java.lang.String	getCategory() The category of the dataset.
IPropertySet	getConnectionProperties() The connection properties of the workspace.
IEnumDatasetName	getDatasetNames(int datasetType) The DatasetNames in the workspace.
IEnumDataset	getDatasets(int datasetType) The datasets in the workspace.
IName	getFullName() The associated name object.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the Dataset.
java.lang.String	getPathName() The file system full path of the workspace.
IWorkspaceProperty	getProperty(int propertyGroup, int propertyType) Information about this particular property.
IPropertySet	getPropertySet() The set of properties for the dataset.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getType() The Type of the Workspace.
IWorkspace	getWorkspace() The workspace containing this dataset.
IWorkspaceFactory	getWorkspaceFactory() The factory that created the workspace.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isDirectory() TRUE if the workspace is a file system directory.
boolean	isWorkspace(java.lang.String name) Indicates if the file path specified is a raster workspace.
IRasterDataset	openRasterDataset(java.lang.String name) Opens a RasterDataset in the workspace given its name.
IRasterDataset	openRasterDatasetFromBytes(byte[] ppBytes, boolean copy) Opens a RasterDataset from an in-memry image.
void	release() Release a RasterWorkspace.
void	rename(java.lang.String name) Renames this Dataset.
void	setBrowseName(java.lang.String name) The browse name of the dataset.
void	setProperty(int propertyGroup, int propertyType, IWorkspaceProperty workspaceProperty) Information about this particular property.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterWorkspace

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

Construct a RasterWorkspace using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterWorkspace.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
RasterWorkspace o = (RasterWorkspace)obj; // will not work

RasterWorkspace o = new RasterWorkspace(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems RasterWorkspace theRasterWorkspace = (RasterWorkspace) obj;

Method Detail

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

Specified by:

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

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws java.io.IOException,
                                            AutomationException

The connection properties of the workspace.

Specified by:

getConnectionProperties in interface IWorkspace

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFactory

public IWorkspaceFactory getWorkspaceFactory()
                                      throws java.io.IOException,
                                             AutomationException

The factory that created the workspace.

Specified by:

getWorkspaceFactory in interface IWorkspace

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasets

public IEnumDataset getDatasets(int datasetType)
                         throws java.io.IOException,
                                AutomationException

The datasets in the workspace.

Specified by:

getDatasets in interface IWorkspace

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IEnumDatasetName getDatasetNames(int datasetType)
                                 throws java.io.IOException,
                                        AutomationException

The DatasetNames in the workspace.

Specified by:

getDatasetNames in interface IWorkspace

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPathName

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

The file system full path of the workspace.

Specified by:

getPathName in interface IWorkspace

Returns:

The pathName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The Type of the Workspace.

Specified by:

getType in interface IDataset

Specified by:

getType in interface IWorkspace

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirectory

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

TRUE if the workspace is a file system directory.

Specified by:

isDirectory in interface IWorkspace

Returns:

The isDir

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exists

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

Checks if the workspace exists.

Specified by:

exists in interface IWorkspace

Returns:

The exists

Throws:

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

AutomationException - If the ArcObject component throws an exception.

executeSQL

public void executeSQL(java.lang.String sqlStmt)
                throws java.io.IOException,
                       AutomationException

Executes the specified SQL statement.

Specified by:

executeSQL in interface IWorkspace

Parameters:

sqlStmt - The sqlStmt (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openRasterDataset

public IRasterDataset openRasterDataset(java.lang.String name)
                                 throws java.io.IOException,
                                        AutomationException

Opens a RasterDataset in the workspace given its name.

Specified by:

openRasterDataset in interface IRasterWorkspace

Specified by:

openRasterDataset in interface IRasterWorkspace2

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isWorkspace

public boolean isWorkspace(java.lang.String name)
                    throws java.io.IOException,
                           AutomationException

Indicates if the file path specified is a raster workspace.

Specified by:

isWorkspace in interface IRasterWorkspace

Specified by:

isWorkspace in interface IRasterWorkspace2

Parameters:

name - The name (in)

Returns:

The isWorkspace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canCopy

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

Indicates if this dataset can be copied.

Specified by:

canCopy in interface IRasterWorkspace

Specified by:

canCopy in interface IDataset

Specified by:

canCopy in interface IRasterWorkspace2

Returns:

The canCopy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException

Copies this workspace to a new workspace with the specified name.

Specified by:

copy in interface IRasterWorkspace

Specified by:

copy in interface IDataset

Specified by:

copy in interface IRasterWorkspace2

Parameters:

copyName - The copyName (in)

copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRasterDataset

public IRasterDataset createRasterDataset(java.lang.String name,
                                          java.lang.String format,
                                          IPoint origin,
                                          int columnCount,
                                          int rowCount,
                                          double cellSizeX,
                                          double cellSizeY,
                                          int numBands,
                                          int pixelType,
                                          ISpatialReference spatialReference,
                                          boolean permanent)
                                   throws java.io.IOException,
                                          AutomationException

Creates a RasterDataset in the workspace given its name.

Specified by:

createRasterDataset in interface IRasterWorkspace2

Parameters:

name - The name (in)

format - The format (in)

origin - A reference to a com.esri.arcgis.geometry.IPoint (in)

columnCount - The columnCount (in)

rowCount - The rowCount (in)

cellSizeX - The cellSizeX (in)

cellSizeY - The cellSizeY (in)

numBands - The numBands (in)

pixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in, optional, pass 0 if not required)

permanent - The permanent (in, optional, pass true if not required)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openRasterDatasetFromBytes

public IRasterDataset openRasterDatasetFromBytes(byte[] ppBytes,
                                                 boolean copy)
                                          throws java.io.IOException,
                                                 AutomationException

Opens a RasterDataset from an in-memry image.

Specified by:

openRasterDatasetFromBytes in interface IRasterWorkspace3

Parameters:

ppBytes - An unsigned byte (in)

copy - The copy (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the Dataset.

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

The associated name object.

Specified by:

getFullName in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrowseName

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

The browse name of the dataset.

Specified by:

getBrowseName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

The browse name of the dataset.

Specified by:

setBrowseName in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

The category of the dataset.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException

Datasets contained within this dataset.

Specified by:

getSubsets in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

The workspace containing this dataset.

Specified by:

getWorkspace in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException

The set of properties for the dataset.

Specified by:

getPropertySet in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canDelete

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

True if this dataset can be deleted.

Specified by:

canDelete in interface IDataset

Returns:

The canDelete

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

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

Deletes this dataset.

Specified by:

delete in interface IDataset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRename

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

True if this dataset can be renamed.

Specified by:

canRename in interface IDataset

Returns:

The canRename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Renames this Dataset.

Specified by:

rename in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProperty

public IWorkspaceProperty getProperty(int propertyGroup,
                                      int propertyType)
                               throws java.io.IOException,
                                      AutomationException

Information about this particular property.

Specified by:

getProperty in interface IWorkspaceProperties

Parameters:

propertyGroup - A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)

propertyType - The propertyType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(int propertyGroup,
                        int propertyType,
                        IWorkspaceProperty workspaceProperty)
                 throws java.io.IOException,
                        AutomationException

Information about this particular property.

Specified by:

setProperty in interface IWorkspaceProperties

Parameters:

propertyGroup - A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)

propertyType - The propertyType (in)

workspaceProperty - A reference to a com.esri.arcgis.geodatabase.IWorkspaceProperty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.