com.esri.arcgis.datasourcesraster
Class Raster

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

All Implemented Interfaces:

IPixelOperation, IRaster2, IRasterAnalysisProps, IRasterBandCollection, IRasterDefaultProps, IRasterEdit, IRasterProps, IRasterResamplingControl, IRawBlocks, IGeoDataset, IRaster, ISaveAs, ISaveAs2, com.esri.arcgis.interop.RemoteObjRef, IClone, ISupportErrorInfo, java.io.Serializable

public class Raster
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRaster, IRaster2, IRasterEdit, IRasterProps, IGeoDataset, IRasterBandCollection, IRasterDefaultProps, IRasterAnalysisProps, ISupportErrorInfo, ISaveAs, ISaveAs2, IClone, IPixelOperation, IRawBlocks, IRasterResamplingControl

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

Description 'An in-memory representation of a dynamic raster that can perform resampling and reprojection.' 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.IRaster

IID, IIDaeec7d31_1533_11d2_8d25_0000f8780535, xxDummy

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

IID, IID0d668d08_92c1_4999_9a77_490790821969, xxDummy

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

IID, IID32656121_4df9_45f3_bdd1_507d481e9b49, xxDummy

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

IID, IID4b7b1bd0_a705_11d2_8e30_00a0249480f0, xxDummy

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

IID, IID7aca3d10_0629_11d2_8d24_0000f8780535, xxDummy

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

IID, IIDe3afbee0_2dad_11d3_a3f6_0004ac1b1d86, xxDummy

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

IID, IID31e5ff30_2dad_11d3_a3f6_0004ac1b1d86, 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.ISaveAs2

IID, IIDba3968e7_a18b_416d_8140_e4a06068cf1b, xxDummy

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

IIDc7a92e97_597e_4a69_a872_29cb60b5e0db

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

IID, IID467f7216_8ac1_4aac_98bb_e656c135567a, xxDummy

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

IID, IIDf20ff8ff_643a_4669_a465_e14a5095e7dd, xxDummy

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

IID, IIDdfef659c_012d_41ae_965d_5e1ec4841add, xxDummy

Constructor Summary

Raster()
Constructs a Raster using ArcGIS Engine.

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

Method Summary

void	add(IRasterBand element, int index) Adds a RasterBand to the band collection.
void	appendBand(IRasterBand element) Appends a RasterBand to the band collection.
void	appendBands(IRasterBandCollection bands) Appends a collection of RasterBands to the band collection.
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	canEdit() Checks if this Raster can be edited.
boolean	canSaveAs(java.lang.String format) Checks if it's can be saved as a new persistent Dataset of a given format.
void	clear() Removes all the elements in the collection.
IRasterCursor	createCursor() Allocates a Raster Cursor for fast raster scanning.
IRasterCursor	createCursorEx(IPnt pBlockSize) Creates a cursor with a given pixel block size or native block size.
IPixelBlock	createPixelBlock() Create a compatible pixel block.
IPixelBlock	createPixelBlock(IPnt size) Allocates a PixelBlock of requested size.
boolean	equals(java.lang.Object o) Compare this object with another
void	erase(IPnt pTlc, IPixelBlock pPixelBlock) Erases a PixelBlock starting at a given Top-Left corner.
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	flush() Flushes buffered data.
IEnvelope	getAnalysisExtent() The analysis extent of the raster.
ITable	getAttributeTable() The raster value attribute table.
IRasterBand	getBandByName(java.lang.String name) A RasterBand given its name.
int	getBandIndex(java.lang.String name) The index of a RasterBand given its name.
IEnumRasterBand	getBands() All the bands in the collection as an interface to the RasterBands enumerator object.
static java.lang.String	getClsid() getClsid.
IRasterColormap	getColormap() The colormap.
int	getCount() The number of bands in the collection.
IEnvelope	getDefaultIntersectExtent() The default intersect extent.
double	getDefaultPixelHeight() The default pixel size in Y.
double	getDefaultPixelWidth() The default pixel size in X.
ISpatialReference	getDefaultSpatialReference() The default spatial reference.
IEnvelope	getDefaultUnionExtent() The default union extent.
IEnvelope	getExtent() The extent of the Raster.
IGeodataXform	getGeodataXform() The geodata transform.
IGeoTransformationOperationSet	getGeoTransformations() The set of geographic transformations to be applied.
int	getHeight() Height in pixels.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.Object	getNoDataValue() Data value used to indicate invalid or excluded data.
IPixelFilter	getPixelFilter() The pixel filter for filtering pixel values.
double	getPixelHeight() The pixel height in ground resolution.
int	getPixelType() Data type of the pixels.
java.lang.Object	getPixelValue(int iBand, int iColumn, int iRow) Gets the pixel value for a given band at a given column and row.
double	getPixelWidth() The pixel width in ground resolution.
IRasterDataset	getRasterDataset() The parent raster dataset.
IRasterInfo	getRasterInfo() The raster information.
IRasterXformer	getRasterXformer() The raster transformer.
int	getResampleMethod() Interpolation method used when reading pixels.
int	getResamplingHint() The raster resampling hint.
ISpatialReference	getSpatialReference() SpatialReference of the Raster.
int	getWidth() Width in pixels.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isInteger() Indicates if the data is integer.
IRasterBand	item(int bandIndex) Returns a RasterBand given its index.
void	makePermanent() Makes a temporary raster a permanent raster dataset.
void	mapToPixel(double x, double y, int[] pColumn, int[] pRow) Converts a location (x, y) in map space into pixel space.
IPnt	meanCellSize() Returns the approximate cell size of the raster.
void	pixelToMap(int iColumn, int iRow, double[] pX, double[] pY) Converts a location (column, row) in pixel space into map space.
void	read(IPnt tlc, IPixelBlock block) Read a block of pixels starting from the top left corner.
void	readBlock(int tx, int ty, int level, IPixelBlock pPixelBlock) Reads a raw pixel block.
void	refresh() Refreshes the associated RasterDataset.
void	release() Release a Raster.
void	remove(int index) Removes an element from the collection.
void	resetToDefault() Resets the raster to default state
IDataset	saveAs(java.lang.String new_name, IWorkspace worksp, java.lang.String format) Creates a new persistent RasterDataset with the bands in the collection.
IRasterDataset	saveAsRasterDataset(java.lang.String name, IWorkspace workspace, java.lang.String format, IRasterStorageDef storageDef) Creates a new persistent Raster Dataset of a given format and specified storage definition.
void	setAnalysisExtentByRef(IEnvelope ppExtent) The analysis extent of the raster.
void	setAttributeTableByRef(ITable ppVAT) The raster value attribute table.
void	setColormapByRef(IRasterColormap ppColormap) The colormap.
void	setExtent(IEnvelope ppExtent) The extent of the Raster.
void	setGeodataXform(IGeodataXform ppXform) The geodata transform.
void	setGeoTransformationsByRef(IGeoTransformationOperationSet ppGeoXforms) The set of geographic transformations to be applied.
void	setHeight(int pVal) Height in pixels.
void	setNoDataValue(java.lang.Object pVal) Data value used to indicate invalid or excluded data.
void	setPixelFilterByRef(IPixelFilter ppFilter) The pixel filter for filtering pixel values.
void	setPixelHeight(double height) The pixel height in ground resolution.
void	setPixelType(int pVal) Data type of the pixels.
void	setPixelWidth(double width) The pixel width in ground resolution.
void	setResampleMethod(int val) Interpolation method used when reading pixels.
void	setResamplingHint(int pHint) The raster resampling hint.
void	setSpatialReference(ISpatialReference ppSpref) SpatialReference of the Raster.
void	setWidth(int pVal) Width in pixels.
double	toMapX(int iColumn) Maps a pixel column to the x coordinate in map space.
double	toMapY(int iRow) Maps a pixel row to the y coordinate in map space.
int	toPixelColumn(double x) Maps a x coordinate in map space to the pixel column.
int	toPixelRow(double y) Maps a y coordinate in map space to the pixel row.
void	write(IPnt pTlc, IPixelBlock pPixelBlock) Writes a PixelBlock starting at a given Top-Left corner.
void	writeBlock(int tx, int ty, int level, IPixelBlock pPixelBlock) Writes a raw pixel block.

Methods inherited from class java.lang.Object

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

Constructor Detail

Raster

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

Constructs a Raster using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Raster

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a Raster.

Specified by:

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

read

public void read(IPnt tlc,
                 IPixelBlock block)
          throws java.io.IOException,
                 AutomationException

Read a block of pixels starting from the top left corner.

Specified by:

read in interface IRaster

Parameters:

tlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

block - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createPixelBlock

public IPixelBlock createPixelBlock(IPnt size)
                             throws java.io.IOException,
                                    AutomationException

Allocates a PixelBlock of requested size.

Specified by:

createPixelBlock in interface IRaster

Parameters:

size - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createCursor

public IRasterCursor createCursor()
                           throws java.io.IOException,
                                  AutomationException

Allocates a Raster Cursor for fast raster scanning.

Specified by:

createCursor in interface IRaster

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResampleMethod

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

Interpolation method used when reading pixels.

Specified by:

getResampleMethod in interface IRaster

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResampleMethod

public void setResampleMethod(int val)
                       throws java.io.IOException,
                              AutomationException

Interpolation method used when reading pixels.

Specified by:

setResampleMethod in interface IRaster

Parameters:

val - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeodataXform

public IGeodataXform getGeodataXform()
                              throws java.io.IOException,
                                     AutomationException

The geodata transform.

Specified by:

getGeodataXform in interface IRaster2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeodataXform

public void setGeodataXform(IGeodataXform ppXform)
                     throws java.io.IOException,
                            AutomationException

The geodata transform.

Specified by:

setGeodataXform in interface IRaster2

Parameters:

ppXform - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeoTransformationsByRef

public void setGeoTransformationsByRef(IGeoTransformationOperationSet ppGeoXforms)
                                throws java.io.IOException,
                                       AutomationException

The set of geographic transformations to be applied.

Specified by:

setGeoTransformationsByRef in interface IRaster2

Parameters:

ppGeoXforms - A reference to a com.esri.arcgis.geometry.IGeoTransformationOperationSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeoTransformations

public IGeoTransformationOperationSet getGeoTransformations()
                                                     throws java.io.IOException,
                                                            AutomationException

The set of geographic transformations to be applied.

Specified by:

getGeoTransformations in interface IRaster2

Returns:

A reference to a com.esri.arcgis.geometry.IGeoTransformationOperationSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAttributeTable

public ITable getAttributeTable()
                         throws java.io.IOException,
                                AutomationException

The raster value attribute table.

Specified by:

getAttributeTable in interface IRaster2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAttributeTableByRef

public void setAttributeTableByRef(ITable ppVAT)
                            throws java.io.IOException,
                                   AutomationException

The raster value attribute table.

Specified by:

setAttributeTableByRef in interface IRaster2

Parameters:

ppVAT - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColormap

public IRasterColormap getColormap()
                            throws java.io.IOException,
                                   AutomationException

The colormap.

Specified by:

getColormap in interface IRaster2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColormapByRef

public void setColormapByRef(IRasterColormap ppColormap)
                      throws java.io.IOException,
                             AutomationException

The colormap.

Specified by:

setColormapByRef in interface IRaster2

Parameters:

ppColormap - A reference to a com.esri.arcgis.geodatabase.IRasterColormap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterDataset

public IRasterDataset getRasterDataset()
                                throws java.io.IOException,
                                       AutomationException

The parent raster dataset.

Specified by:

getRasterDataset in interface IRaster2

Specified by:

getRasterDataset in interface IRasterAnalysisProps

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.

createCursorEx

public IRasterCursor createCursorEx(IPnt pBlockSize)
                             throws java.io.IOException,
                                    AutomationException

Creates a cursor with a given pixel block size or native block size.

Specified by:

createCursorEx in interface IRaster2

Parameters:

pBlockSize - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterXformer

public IRasterXformer getRasterXformer()
                                throws java.io.IOException,
                                       AutomationException

The raster transformer.

Specified by:

getRasterXformer in interface IRaster2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

mapToPixel

public void mapToPixel(double x,
                       double y,
                       int[] pColumn,
                       int[] pRow)
                throws java.io.IOException,
                       AutomationException

Converts a location (x, y) in map space into pixel space.

Specified by:

mapToPixel in interface IRaster2

Parameters:

x - The x (in)

y - The y (in)

pColumn - The pColumn (out: use single element array)

pRow - The pRow (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

pixelToMap

public void pixelToMap(int iColumn,
                       int iRow,
                       double[] pX,
                       double[] pY)
                throws java.io.IOException,
                       AutomationException

Converts a location (column, row) in pixel space into map space.

Specified by:

pixelToMap in interface IRaster2

Parameters:

iColumn - The iColumn (in)

iRow - The iRow (in)

pX - The pX (out: use single element array)

pY - The pY (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toPixelColumn

public int toPixelColumn(double x)
                  throws java.io.IOException,
                         AutomationException

Maps a x coordinate in map space to the pixel column.

Specified by:

toPixelColumn in interface IRaster2

Parameters:

x - The x (in)

Returns:

The pColumn

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toPixelRow

public int toPixelRow(double y)
               throws java.io.IOException,
                      AutomationException

Maps a y coordinate in map space to the pixel row.

Specified by:

toPixelRow in interface IRaster2

Parameters:

y - The y (in)

Returns:

The pRow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toMapX

public double toMapX(int iColumn)
              throws java.io.IOException,
                     AutomationException

Maps a pixel column to the x coordinate in map space.

Specified by:

toMapX in interface IRaster2

Parameters:

iColumn - The iColumn (in)

Returns:

The pX

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toMapY

public double toMapY(int iRow)
              throws java.io.IOException,
                     AutomationException

Maps a pixel row to the y coordinate in map space.

Specified by:

toMapY in interface IRaster2

Parameters:

iRow - The iRow (in)

Returns:

The pY

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelValue

public java.lang.Object getPixelValue(int iBand,
                                      int iColumn,
                                      int iRow)
                               throws java.io.IOException,
                                      AutomationException

Gets the pixel value for a given band at a given column and row.

Specified by:

getPixelValue in interface IRaster2

Parameters:

iBand - The iBand (in)

iColumn - The iColumn (in)

iRow - The iRow (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canEdit

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

Checks if this Raster can be edited.

Specified by:

canEdit in interface IRasterEdit

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

write

public void write(IPnt pTlc,
                  IPixelBlock pPixelBlock)
           throws java.io.IOException,
                  AutomationException

Writes a PixelBlock starting at a given Top-Left corner.

Specified by:

write in interface IRasterEdit

Parameters:

pTlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

pPixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

erase

public void erase(IPnt pTlc,
                  IPixelBlock pPixelBlock)
           throws java.io.IOException,
                  AutomationException

Erases a PixelBlock starting at a given Top-Left corner.

Specified by:

erase in interface IRasterEdit

Parameters:

pTlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

pPixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

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

Refreshes the associated RasterDataset.

Specified by:

refresh in interface IRasterEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWidth

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

Width in pixels.

Specified by:

getWidth in interface IRasterProps

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int pVal)
              throws java.io.IOException,
                     AutomationException

Width in pixels.

Specified by:

setWidth in interface IRasterProps

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

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

Height in pixels.

Specified by:

getHeight in interface IRasterProps

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int pVal)
               throws java.io.IOException,
                      AutomationException

Height in pixels.

Specified by:

setHeight in interface IRasterProps

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelType

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

Data type of the pixels.

Specified by:

getPixelType in interface IRasterProps

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int pVal)
                  throws java.io.IOException,
                         AutomationException

Data type of the pixels.

Specified by:

setPixelType in interface IRasterProps

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataValue

public java.lang.Object getNoDataValue()
                                throws java.io.IOException,
                                       AutomationException

Data value used to indicate invalid or excluded data.

Specified by:

getNoDataValue in interface IRasterProps

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoDataValue

public void setNoDataValue(java.lang.Object pVal)
                    throws java.io.IOException,
                           AutomationException

Data value used to indicate invalid or excluded data.

Specified by:

setNoDataValue in interface IRasterProps

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

meanCellSize

public IPnt meanCellSize()
                  throws java.io.IOException,
                         AutomationException

Returns the approximate cell size of the raster.

Specified by:

meanCellSize in interface IRasterProps

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isInteger

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

Indicates if the data is integer.

Specified by:

isInteger in interface IRasterProps

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

SpatialReference of the Raster.

Specified by:

getSpatialReference in interface IRasterProps

Specified by:

getSpatialReference in interface IGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReference

public void setSpatialReference(ISpatialReference ppSpref)
                         throws java.io.IOException,
                                AutomationException

SpatialReference of the Raster.

Specified by:

setSpatialReference in interface IRasterProps

Parameters:

ppSpref - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent of the Raster.

Specified by:

getExtent in interface IRasterProps

Specified by:

getExtent in interface IGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(IEnvelope ppExtent)
               throws java.io.IOException,
                      AutomationException

The extent of the Raster.

Specified by:

setExtent in interface IRasterProps

Parameters:

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(IRasterBand element,
                int index)
         throws java.io.IOException,
                AutomationException

Adds a RasterBand to the band collection.

Specified by:

add in interface IRasterBandCollection

Parameters:

element - A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

The number of bands in the collection.

Specified by:

getCount in interface IRasterBandCollection

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clear

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

Removes all the elements in the collection.

Specified by:

clear in interface IRasterBandCollection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws java.io.IOException,
                   AutomationException

Removes an element from the collection.

Specified by:

remove in interface IRasterBandCollection

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandIndex

public int getBandIndex(java.lang.String name)
                 throws java.io.IOException,
                        AutomationException

The index of a RasterBand given its name.

Specified by:

getBandIndex in interface IRasterBandCollection

Parameters:

name - The name (in)

Returns:

The bandIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandByName

public IRasterBand getBandByName(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

A RasterBand given its name.

Specified by:

getBandByName in interface IRasterBandCollection

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBands

public IEnumRasterBand getBands()
                         throws java.io.IOException,
                                AutomationException

All the bands in the collection as an interface to the RasterBands enumerator object.

Specified by:

getBands in interface IRasterBandCollection

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

item

public IRasterBand item(int bandIndex)
                 throws java.io.IOException,
                        AutomationException

Returns a RasterBand given its index.

Specified by:

item in interface IRasterBandCollection

Parameters:

bandIndex - The bandIndex (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveAs

public IDataset saveAs(java.lang.String new_name,
                       IWorkspace worksp,
                       java.lang.String format)
                throws java.io.IOException,
                       AutomationException

Creates a new persistent RasterDataset with the bands in the collection.

Specified by:

saveAs in interface IRasterBandCollection

Specified by:

saveAs in interface ISaveAs

Parameters:

new_name - The new_name (in)

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

format - The format (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.

appendBand

public void appendBand(IRasterBand element)
                throws java.io.IOException,
                       AutomationException

Appends a RasterBand to the band collection.

Specified by:

appendBand in interface IRasterBandCollection

Parameters:

element - A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

appendBands

public void appendBands(IRasterBandCollection bands)
                 throws java.io.IOException,
                        AutomationException

Appends a collection of RasterBands to the band collection.

Specified by:

appendBands in interface IRasterBandCollection

Parameters:

bands - A reference to a com.esri.arcgis.datasourcesraster.IRasterBandCollection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultPixelWidth

public double getDefaultPixelWidth()
                            throws java.io.IOException,
                                   AutomationException

The default pixel size in X.

Specified by:

getDefaultPixelWidth in interface IRasterDefaultProps

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultPixelHeight

public double getDefaultPixelHeight()
                             throws java.io.IOException,
                                    AutomationException

The default pixel size in Y.

Specified by:

getDefaultPixelHeight in interface IRasterDefaultProps

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultUnionExtent

public IEnvelope getDefaultUnionExtent()
                                throws java.io.IOException,
                                       AutomationException

The default union extent.

Specified by:

getDefaultUnionExtent in interface IRasterDefaultProps

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultIntersectExtent

public IEnvelope getDefaultIntersectExtent()
                                    throws java.io.IOException,
                                           AutomationException

The default intersect extent.

Specified by:

getDefaultIntersectExtent in interface IRasterDefaultProps

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultSpatialReference

public ISpatialReference getDefaultSpatialReference()
                                             throws java.io.IOException,
                                                    AutomationException

The default spatial reference.

Specified by:

getDefaultSpatialReference in interface IRasterDefaultProps

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetToDefault

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

Resets the raster to default state

Specified by:

resetToDefault in interface IRasterDefaultProps

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelWidth

public void setPixelWidth(double width)
                   throws java.io.IOException,
                          AutomationException

The pixel width in ground resolution.

Specified by:

setPixelWidth in interface IRasterAnalysisProps

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelWidth

public double getPixelWidth()
                     throws java.io.IOException,
                            AutomationException

The pixel width in ground resolution.

Specified by:

getPixelWidth in interface IRasterAnalysisProps

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelHeight

public void setPixelHeight(double height)
                    throws java.io.IOException,
                           AutomationException

The pixel height in ground resolution.

Specified by:

setPixelHeight in interface IRasterAnalysisProps

Parameters:

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelHeight

public double getPixelHeight()
                      throws java.io.IOException,
                             AutomationException

The pixel height in ground resolution.

Specified by:

getPixelHeight in interface IRasterAnalysisProps

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnalysisExtent

public IEnvelope getAnalysisExtent()
                            throws java.io.IOException,
                                   AutomationException

The analysis extent of the raster.

Specified by:

getAnalysisExtent in interface IRasterAnalysisProps

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnalysisExtentByRef

public void setAnalysisExtentByRef(IEnvelope ppExtent)
                            throws java.io.IOException,
                                   AutomationException

The analysis extent of the raster.

Specified by:

setAnalysisExtentByRef in interface IRasterAnalysisProps

Parameters:

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

makePermanent

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

Makes a temporary raster a permanent raster dataset.

Specified by:

makePermanent in interface IRasterAnalysisProps

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.

canSaveAs

public boolean canSaveAs(java.lang.String format)
                  throws java.io.IOException,
                         AutomationException

Checks if it's can be saved as a new persistent Dataset of a given format.

Specified by:

canSaveAs in interface ISaveAs

Parameters:

format - The format (in)

Returns:

The canSaveAs

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveAsRasterDataset

public IRasterDataset saveAsRasterDataset(java.lang.String name,
                                          IWorkspace workspace,
                                          java.lang.String format,
                                          IRasterStorageDef storageDef)
                                   throws java.io.IOException,
                                          AutomationException

Creates a new persistent Raster Dataset of a given format and specified storage definition.

Specified by:

saveAsRasterDataset in interface ISaveAs2

Parameters:

name - The name (in)

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

format - The format (in)

storageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (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.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelFilter

public IPixelFilter getPixelFilter()
                            throws java.io.IOException,
                                   AutomationException

The pixel filter for filtering pixel values.

Specified by:

getPixelFilter in interface IPixelOperation

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelFilterByRef

public void setPixelFilterByRef(IPixelFilter ppFilter)
                         throws java.io.IOException,
                                AutomationException

The pixel filter for filtering pixel values.

Specified by:

setPixelFilterByRef in interface IPixelOperation

Parameters:

ppFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

public IRasterInfo getRasterInfo()
                          throws java.io.IOException,
                                 AutomationException

The raster information.

Specified by:

getRasterInfo in interface IRawBlocks

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createPixelBlock

public IPixelBlock createPixelBlock()
                             throws java.io.IOException,
                                    AutomationException

Create a compatible pixel block.

Specified by:

createPixelBlock in interface IRawBlocks

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readBlock

public void readBlock(int tx,
                      int ty,
                      int level,
                      IPixelBlock pPixelBlock)
               throws java.io.IOException,
                      AutomationException

Reads a raw pixel block.

Specified by:

readBlock in interface IRawBlocks

Parameters:

tx - The tx (in)

ty - The ty (in)

level - The level (in)

pPixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeBlock

public void writeBlock(int tx,
                       int ty,
                       int level,
                       IPixelBlock pPixelBlock)
                throws java.io.IOException,
                       AutomationException

Writes a raw pixel block.

Specified by:

writeBlock in interface IRawBlocks

Parameters:

tx - The tx (in)

ty - The ty (in)

level - The level (in)

pPixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

flush

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

Flushes buffered data.

Specified by:

flush in interface IRawBlocks

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResamplingHint

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

The raster resampling hint.

Specified by:

getResamplingHint in interface IRasterResamplingControl

Returns:

A com.esri.arcgis.geodatabase.esriRasterResamplingHint constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResamplingHint

public void setResamplingHint(int pHint)
                       throws java.io.IOException,
                              AutomationException

The raster resampling hint.

Specified by:

setResamplingHint in interface IRasterResamplingControl

Parameters:

pHint - A com.esri.arcgis.geodatabase.esriRasterResamplingHint constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.