|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.datasourcesraster.RasterWorkspace
public class RasterWorkspace
The raster workspace object.
The RasterWorkspace is one type of Workspace. It accesses raster data stored in file system such as ESRI GRID, ERDAS Imagine, TIFF, or any of other supported formats.
IWorkspaceFactory rasWkspFactory = new RasterWorkspaceFactory();
Constructor Summary | |
---|---|
RasterWorkspace(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(String copyName,
IWorkspace copyWorkspace)
Copies this workspace to a new workspace with the specified name. |
IRasterDataset |
createRasterDataset(String name,
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(Object o)
Compare this object with another |
void |
executeSQL(String sqlStmt)
Executes the specified SQL statement. |
boolean |
exists()
Checks if the workspace exists. |
String |
getBrowseName()
The browse name of the dataset. |
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. |
String |
getName()
The name of the Dataset. |
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(String name)
Indicates if the file path specified is a raster workspace. |
IRasterDataset |
openRasterDataset(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 |
rename(String name)
Renames this Dataset. |
void |
setBrowseName(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 |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public RasterWorkspace(Object obj) throws IOException
obj
to RasterWorkspace
. *
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
IOException
- if there are interop problems
RasterWorkspace theRasterWorkspace = (RasterWorkspace) obj;
Method Detail |
---|
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public IPropertySet getConnectionProperties() throws IOException, AutomationException
The ConnectionProperties property of a workspace returns the set of named connection properties for this workspace.
getConnectionProperties
in interface IWorkspace
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspaceFactory getWorkspaceFactory() throws IOException, AutomationException
The WorkspaceFactory property can be used to get a reference back to the workspace factory for this workspace.
getWorkspaceFactory
in interface IWorkspace
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumDataset getDatasets(int datasetType) throws IOException, AutomationException
getDatasets
in interface IWorkspace
datasetType
- A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumDatasetName getDatasetNames(int datasetType) throws IOException, AutomationException
getDatasetNames
in interface IWorkspace
datasetType
- A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getPathName() throws IOException, AutomationException
getPathName
in interface IWorkspace
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getType() throws IOException, AutomationException
getType
in interface IDataset
getType
in interface IWorkspace
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDirectory() throws IOException, AutomationException
isDirectory
in interface IWorkspace
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean exists() throws IOException, AutomationException
This method can be used with workspaces from file-based data sources to detect if they've been deleted by another application. For example, a shapefile workspace is a directory and can be deleted while the workspace is open.
exists
in interface IWorkspace
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void executeSQL(String sqlStmt) throws IOException, AutomationException
The ExecuteSQL method can be used to send an arbitrary SQL statement to the underlying database for execution. The statement can be any DDL (data definition language) or DML (data manipulation language) statement but can not return any result sets. The syntax for the SQL is as required by the underlying database. The workspace supports an optional ISQLSyntax interface that provides information to applications on aspects of the SQL Syntax for the underlying database.
To determine if a workspace supports the ExecutesSQL method, an application can check the value of the canExecuteSQLworkspace property via the optional IWorkspaceProperties interface. In general, this method is only supported on local and remote database workspaces.
executeSQL
in interface IWorkspace
sqlStmt
- The sqlStmt (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterDataset openRasterDataset(String name) throws IOException, AutomationException
openRasterDataset
in interface IRasterWorkspace
openRasterDataset
in interface IRasterWorkspace2
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isWorkspace(String name) throws IOException, AutomationException
isWorkspace
in interface IRasterWorkspace
isWorkspace
in interface IRasterWorkspace2
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canCopy() throws IOException, AutomationException
canCopy
in interface IRasterWorkspace
canCopy
in interface IDataset
canCopy
in interface IRasterWorkspace2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataset copy(String copyName, IWorkspace copyWorkspace) throws IOException, AutomationException
copy
in interface IRasterWorkspace
copy
in interface IDataset
copy
in interface IRasterWorkspace2
copyName
- The copyName (in)copyWorkspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterDataset createRasterDataset(String name, String format, IPoint origin, int columnCount, int rowCount, double cellSizeX, double cellSizeY, int numBands, int pixelType, ISpatialReference spatialReference, boolean permanent) throws IOException, AutomationException
CreateRasterDataset creates a file based raster dataset, the origin, width, and height of the raster dataset must be specified along with other required parameters, the raster dataset with the specified dimension and default pixel values will be created . The default pixel values of the raster dataset can be modified by writting pixel blocks to the dataset or mosaicking.
CreateRasterDataset can be used to create GRID, TIFF, ERDAS Imagine,BMP, Idrisi format, and in memory raster. The strings used to specify formats are "GRID", "TIFF", "IMAGINE Image", "BMP", "RST", and "MEM" respectively. The strings are case-sensitive.
For GRID format, CreateRasterDataset only allows square cell size.
When creating an in memory raster, the file name can be an empty string.
createRasterDataset
in interface IRasterWorkspace2
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterDataset openRasterDatasetFromBytes(byte[] ppBytes, boolean copy) throws IOException, AutomationException
This method is used to open a RasterDataset from bytes, an in-memory image, which is normally created from RasterExplorter or IRasterWorkspace2::CreateRasterDataset with "MEM" string.
openRasterDatasetFromBytes
in interface IRasterWorkspace3
ppBytes
- An unsigned byte (in)copy
- The copy (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName getFullName() throws IOException, AutomationException
getFullName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getBrowseName() throws IOException, AutomationException
getBrowseName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBrowseName(String name) throws IOException, AutomationException
setBrowseName
in interface IDataset
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCategory() throws IOException, AutomationException
IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".
The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.
getCategory
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumDataset getSubsets() throws IOException, AutomationException
The Subsets property returns other Dataset objects contained in this dataset.
IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.
getSubsets
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspace getWorkspace() throws IOException, AutomationException
The Workspace property returns the containing workspace for this dataset.
getWorkspace
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getPropertySet() throws IOException, AutomationException
The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.
Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.
Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.
IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.
getPropertySet
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canDelete() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canDelete
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void delete() throws IOException, AutomationException
Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
delete
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canRename() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canRename
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void rename(String name) throws IOException, AutomationException
IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.
rename
in interface IDataset
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void interfaceSupportsErrorInfo(GUID riid) throws IOException, AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspaceProperty getProperty(int propertyGroup, int propertyType) throws IOException, AutomationException
getProperty
in interface IWorkspaceProperties
propertyGroup
- A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)propertyType
- The propertyType (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setProperty(int propertyGroup, int propertyType, IWorkspaceProperty workspaceProperty) throws IOException, AutomationException
setProperty
in interface IWorkspaceProperties
propertyGroup
- A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)propertyType
- The propertyType (in)workspaceProperty
- A reference to a com.esri.arcgis.geodatabase.IWorkspaceProperty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |