RasterLayer (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class RasterLayer

java.lang.Object
  com.esri.arcgis.carto.RasterLayer

All Implemented Interfaces:: java.util.EventListener, IAttributeTable, IClass, IConnectionPointContainer, IDataLayer, IDataLayer2, IDataset, IDisplayAdmin, IDisplayAdmin2, IDisplayRelationshipClass, IDisplayTable, IGeoDataset, IGeoReference, IIdentify, ILayer, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerFields, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILegendInfo, IObjectClass, IPersist, IPersistStream, IPublishLayer, IRasterDataManagementEvents, IRasterLayer, IRasterSpatialSelection, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ITable, ITableFields, ITableSelection, ITemporaryLayer, java.io.Serializable

public class RasterLayer
extends java.lang.Object
implements IRasterLayer, IGeoDataset, ILegendInfo, IPersistStream, IIdentify, ILayerInfo, IDataLayer, IDataLayer2, ILayerEffects, IDisplayAdmin, IDisplayAdmin2, IGeoReference, IDisplayTable, ITableSelection, IClass, ITable, IObjectClass, ILayerFields, ITableFields, IDisplayRelationshipClass, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ILayerExtensions, ILayerDrawingProperties, ILayerGeneralProperties, ILayerPosition, IAttributeTable, IConnectionPointContainer, IDataset, IPublishLayer, IRasterSpatialSelection, IRasterDataManagementEvents, ITemporaryLayer

Raster layer source and display options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

A RasterLayer object can be initialized from a file on disk, a Raster object or a RasterDataset object.

A RasterLayer can be retrieved from IMap::Layer property also, if the Map contains a raster layer.

See Also:: IRasterLayer, Serialized Form

Constructor Summary
`RasterLayer()` Constructs a RasterLayer using ArcGIS Engine.
`RasterLayer(java.lang.Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary
`void`	`addExtension(java.lang.Object ext)` Adds a new extension.
`void`	`addField(IField field)` Adds a field to this object class.
`void`	`addIGeoReferenceEventsListener(IGeoReferenceEvents theListener)`
`void`	`addILayerEventsListener(ILayerEvents theListener)`
`void`	`addIndex(IIndex index)` Adds an index to this object class.
`void`	`addRelationshipClass(IRelationshipClass relationshipClass)` Adds the specified memory relationship class to a standalone table or layer.
`void`	`addRow(IRow row)` Adds a row to the selection set (honoring the current combination method).
`boolean`	`canCopy()` True if this dataset can be copied.
`boolean`	`canDelete()` True if this dataset can be deleted.
`boolean`	`canRename()` True if this dataset can be renamed.
`void`	`clear()` Clears the selection.
`boolean`	`connect(IName pOptRepairName)` Connects the layer to its data source.
`IDataset`	`copy(java.lang.String copyName, IWorkspace copyWorkspace)` Copies this dataset to a new dataset with the specified name.
`void`	`createFromDataset(IRasterDataset rasterDataset)` Creates a layer from a RasterDataset object.
`void`	`createFromFilePath(java.lang.String filePath)` Creates a layer from a file path to raster data.
`void`	`createFromRaster(IRaster raster)` Creates a layer from a Raster object.
`IRow`	`createRow()` Creates a row in the database with a system assigned object ID and null property values.
`IRowBuffer`	`createRowBuffer()` Creates a row buffer that can be used with an insert cursor.
`void`	`delete()` Deletes this dataset.
`void`	`deleteField(IField field)` Deletes a field from this object class.
`void`	`deleteIndex(IIndex index)` Deletes an index from this object class.
`void`	`deleteSearchedRows(IQueryFilter queryFilter)` Delete the Rows in the database selected by the specified query.
`void`	`disconnect()` Disconnects the data from the layer.
`void`	`displayRelationshipClass(IRelationshipClass relClass, int joinType)` Sets a join based on the specified relationship class and join type.
`void`	`draw(int drawPhase, IDisplay display, ITrackCancel trackCancel)` Draws the layer to the specified display for the given draw phase.
`void`	`drawSpatialSelection(IDisplay pDisplay, ITrackCancel pTrackCancel)` Draws the current spatial selection.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` Supported Platforms
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` Supported Platforms
`int`	`findField(java.lang.String name)` The index of the field with the specified name.
`IEnumRelationshipClass`	`findRelationshipClasses(IObjectClass objectClass, int role)` Finds all relationship classes in the collection that reference the given object class in the specified role.
`void`	`flip()` Flip operation of layer.
`java.lang.String`	`getAliasName()` The alias name of the object class.
`IEnvelope`	`getAreaOfInterest()` The default area of interest for the layer.
`IAttributeTable`	`getAsIAttributeTable()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IClass`	`getAsIClass()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IConnectionPointContainer`	`getAsIConnectionPointContainer()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDataLayer`	`getAsIDataLayer()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDataLayer2`	`getAsIDataLayer2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDataset`	`getAsIDataset()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDisplayAdmin`	`getAsIDisplayAdmin()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDisplayAdmin2`	`getAsIDisplayAdmin2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDisplayRelationshipClass`	`getAsIDisplayRelationshipClass()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDisplayTable`	`getAsIDisplayTable()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGeoDataset`	`getAsIGeoDataset()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGeoReference`	`getAsIGeoReference()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IIdentify`	`getAsIIdentify()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ILayerDrawingProperties`	`getAsILayerDrawingProperties()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ILayerEffects`	`getAsILayerEffects()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ILayerExtensions`	`getAsILayerExtensions()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ILayerFields`	`getAsILayerFields()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ILayerGeneralProperties`	`getAsILayerGeneralProperties()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ILayerInfo`	`getAsILayerInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ILayerPosition`	`getAsILayerPosition()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ILegendInfo`	`getAsILegendInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IObjectClass`	`getAsIObjectClass()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IPersistStream`	`getAsIPersistStream()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IPublishLayer`	`getAsIPublishLayer()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IRasterDataManagementEvents`	`getAsIRasterDataManagementEvents()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IRasterLayer`	`getAsIRasterLayer()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IRasterSpatialSelection`	`getAsIRasterSpatialSelection()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IRelationshipClassCollection`	`getAsIRelationshipClassCollection()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IRelationshipClassCollectionEdit`	`getAsIRelationshipClassCollectionEdit()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITable`	`getAsITable()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITableFields`	`getAsITableFields()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITableSelection`	`getAsITableSelection()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITemporaryLayer`	`getAsITemporaryLayer()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITable`	`getAttributeTable()` The attribute table.
`int`	`getBandCount()` Number of bands in the layer.
`short`	`getBrightness()` Layer brightness in percent (-100 - 100).
`java.lang.String`	`getBrowseName()` The browse name of the dataset.
`java.lang.String`	`getCategory()` The category of the dataset.
`void`	`getClassID(GUID[] pClassID)` Supported Platforms
`static java.lang.String`	`getClsid()`
`IUID`	`getCLSID()` The GUID for the COM Class (CoClass) corresponding to instances of this object class.
`int`	`getColumnCount()` Number of columns in the layer.
`short`	`getContrast()` Layer contrast in percent (-100 - 100).
`java.lang.String`	`getDataDetails(java.lang.String bsPadding)` Details of the layer's data.
`IEnvelope`	`getDataFrameExtent()` Extent of the dataframe that contains the layer.
`IName`	`getDataSourceName()` Name of the data object for the layer.
`int`	`getDisplayResolutionFactor()` Display resolution factor.
`ISelectionSet`	`getDisplaySelectionSet()` The selected set of rows from the display table.
`ITable`	`getDisplayTable()` The display table.
`IUID`	`getEXTCLSID()` The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
`java.lang.Object`	`getExtension()` The extension for this object class.
`java.lang.Object`	`getExtension(int index)` The extension at the specified index.
`int`	`getExtensionCount()` Number of extensions.
`IPropertySet`	`getExtensionProperties()` The extension properties for this object class.
`IEnvelope`	`getExtent()` The extent of the GeoDataset.
`IField`	`getField(int index)` The field at the specified index.
`int`	`getFieldCount()` The number of fields.
`IFieldInfo`	`getFieldInfo(int index)` Extended field information for the field at the specified index.
`IFields`	`getFields()` The fields collection for this object class.
`java.lang.String`	`getFilePath()` Filepath of the data source.
`IName`	`getFullName()` The associated name object.
`IIndexes`	`getIndexes()` The indexes collection for this object class.
`int`	`getJoinType()` Join type for the most recent join performed.
`int`	`getLargeImage()` Large image that represents the layer.
`int`	`getLargeSelectedImage()` Large image that represents the layer when it is selected.
`double`	`getLastMaximumScale()` Last maximum scale setting used by layer.
`double`	`getLastMinimumScale()` Last minimum scale setting used by layer.
`double`	`getLayerWeight()` Default layer position.
`ILegendGroup`	`getLegendGroup(int index)` Legend group at the specified index.
`int`	`getLegendGroupCount()` Number of legend groups contained by the object.
`ILegendItem`	`getLegendItem()` Optional.
`IRasterDataset`	`getMaskRasterDataset()` Reference to the current selection dataset.
`double`	`getMaximumScale()` Maximum scale (representative fraction) at which the layer will display.
`double`	`getMinimumScale()` Minimum scale (representative fraction) at which the layer will display.
`java.lang.String`	`getName()` The name of the Dataset.
`int`	`getObjectClassID()` The unique ID for the object class.
`java.lang.String`	`getOIDFieldName()` The name of the field corresponding to the OID.
`int`	`getPrimaryField()` Layer's primary field.
`IPropertySet`	`getPropertySet()` The set of properties for the dataset.
`java.lang.String`	`getPublishingDescription()` The layer description reported to the publisher.
`IRaster`	`getRaster()` Layer's Raster object.
`IRelationshipClass`	`getRelationshipClass()` Relationship class that defines how the tables are joined.
`IEnumRelationshipClass`	`getRelationshipClasses()` The memory relationship classes.
`IEnumRelationshipClass`	`getRelationshipClasses(int role)` The relationship classes in which this object class participates in for the specified role.
`java.lang.String`	`getRelativeBase()` Base path used when storing relative path names.
`IRasterRenderer`	`getRenderer()` Layer's renderer.
`IRow`	`getRow(int oID)` The row from the database with the specified object ID.
`int`	`getRowCount()` Number of rows in the layer.
`ICursor`	`getRows(java.lang.Object oids, boolean recycling)` The cursor of rows based on a set of object ids.
`ISelectionSet`	`getSelectionSet()` The selected set of rows.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` Supported Platforms
`int`	`getSmallImage()` Small image that represents the layer.
`int`	`getSmallSelectedImage()` Small image that represents the layer when it is selected.
`ISpatialReference`	`getSpatialReference()` The spatial reference of the GeoDataset.
`IEnumDataset`	`getSubsets()` Datasets contained within this dataset.
`int`	`getSupportedDrawPhases()` Supported draw phases.
`java.lang.String`	`getTipText(double x, double y, double tolerance)` Map tip text at the specified location.
`short`	`getTransparency()` Layer transparency in percent (0-100).
`int`	`getType()` The type of the Dataset.
`IEnvelope`	`getVisibleExtent()` Visible extent of the layer in the data frame.
`IWorkspace`	`getWorkspace()` The workspace containing this dataset.
`int`	`hashCode()` the hashcode for this object
`IArray`	`identify(IGeometry pGeom)` Identifies objects at the specified location.
`java.lang.String`	`ILayerGeneralProperties_getLayerDescription()` Description for the layer.
`void`	`init(boolean bInit, java.lang.String fileFullName, int fileFormat)` Create or remove the selection dataset.
`ICursor`	`insert(boolean useBuffering)` Returns a cursor that can be used to insert new Rows.
`boolean`	`inWorkspace(IWorkspace workspace)` Returns TRUE if the layer is in the specified workspace.
`boolean`	`isCached()` Indicates if the layer needs its own display cache.
`boolean`	`isCanGeoRef()` Indicates if layer can be georeferenced.
`boolean`	`isDataSourceSupported(IName name)` Indicates if the specified data object name is supported by the layer.
`boolean`	`isDataValid()` Indicates if the data for the layer is currently valid.
`void`	`isDirty()` Supported Platforms
`boolean`	`isDoesBlending()` Indicates whether the drawing object blends its output with the background.
`boolean`	`isDrawingPropsDirty()` Indicates if the layer drawing properties are dirty.
`boolean`	`isHasOID()` Indicates if the class has an object identity (OID) field.
`boolean`	`isPyramidPresent()` Indicates if pyramids are present for the layer.
`boolean`	`isRequiresBanding()` Indicates whether the output from the drawing object requires banding.
`boolean`	`isShowResolution()` Indicates if the raster resolution should be displayed in the Table of Contents.
`boolean`	`isShowTips()` Indicates if the layer shows map tips.
`boolean`	`isSupportsBrightnessChange()` Indicates if the layer supports brightness changes.
`boolean`	`isSupportsContrastChange()` Indicates if the layer supports contrast changes.
`boolean`	`isSupportsInteractive()` Indicates if the layer supports interactive effects changes.
`boolean`	`isSupportsPublishing()` Indicates if the layer supports the publishing process.
`boolean`	`isSupportsTransparency()` Indicates if the layer supports transparency.
`boolean`	`isSymbolsAreGraduated()` Indicates if symbols are graduated.
`boolean`	`isTemporary()` Indicates if the layer is a temporary layer.
`boolean`	`isUsesFilter()` Indicates if the current object draws using a filter.
`boolean`	`isValid()` Indicates if the layer is currently valid.
`boolean`	`isVisible()` Indicates if the layer is currently visible.
`ICursor`	`ITable_search(IQueryFilter queryFilter, boolean recycling)` An object cursor that can be used to fetch row objects selected by the specified query.
`void`	`load(IStream pstm)` Supported Platforms
`void`	`maskDrawPolyRect(ITrackCancel trackCancel, java.lang.Object vRects, int op)` Perform the mask operation with the given array of rectangles.
`void`	`maskReadBitmap(ITrackCancel trackCancel, tagRECT pRect, java.lang.Object vBytes, boolean byBits)` Read pixels from selection.
`void`	`maskWriteBitmap(ITrackCancel trackCancel, tagRECT pRect, int op, java.lang.Object vBytes, boolean byBits)` Perform the mask operation with bitmask.
`void`	`mirror()` Mirror operation of layer.
`void`	`onEvent(IRasterDataManagementEventsOnEventEvent theEvent)` Performs operation on the raster data management event.
`IPointCollection`	`pointsTransform(IPointCollection inPoints, boolean isForward)` Transform operation of Raster.
`void`	`prepareForPublishing()` Prepare the layer for the publishing process.
`void`	`rectify(java.lang.String fullpath, java.lang.String format)` Save transformed result to a new dataset.
`void`	`register()` Save transformation parameters and tie-points.
`void`	`removeAllRelationshipClasses()` Removes all memory relationship classes from a standalone table or layer.
`void`	`removeExtension(int index)` Removes the specified extension.
`void`	`removeIGeoReferenceEventsListener(IGeoReferenceEvents theListener)`
`void`	`removeILayerEventsListener(ILayerEvents theListener)`
`void`	`removeRelationshipClass(IRelationshipClass relationshipClass)` Removes the specified memory relationship class from a standalone table or layer.
`void`	`rename(java.lang.String name)` Renames this Dataset.
`void`	`reScale(double xScale, double yScale)` ReScale operation of layer.
`void`	`reset()` Reset operation of layer.
`void`	`rotate(IPoint ipPivotPoint, double angle)` Rotate operation of layer.
`int`	`rowCount(IQueryFilter queryFilter)` The number of Rows selected by the specified query.
`void`	`save(IStream pstm, int fClearDirty)` Supported Platforms
`ICursor`	`searchDisplayTable(IQueryFilter pQueryFilter, boolean recycling)` Creates a cursor from the display table based upon the search criteria.
`ISelectionSet`	`select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer)` A selection that contains the object ids selected by the specified query.
`ISelectionSet`	`selectDisplayTable(IQueryFilter pQueryFilter, int selType, int selOption, IWorkspace pSelWorkspace)` Creates a selection set from the display table based upon the search criteria.
`void`	`selectionChanged()` Fires the layer update event.
`void`	`selectRows(IQueryFilter filter, int method, boolean justOne)` Selects rows based upon the specified criteria and combination method.
`void`	`setBrightness(short brightnessValue)` Layer brightness in percent (-100 - 100).
`void`	`setBrowseName(java.lang.String name)` The browse name of the dataset.
`void`	`setCached(boolean cached)` Indicates if the layer needs its own display cache.
`void`	`setContrast(short contrastValue)` Layer contrast in percent (-100 - 100).
`void`	`setDataSourceName(IName name)` Name of the data object for the layer.
`void`	`setDisplayResolutionFactor(int pnFactor)` Display resolution factor.
`void`	`setDrawingPropsDirty(boolean dirty)` Indicates if the layer drawing properties are dirty.
`void`	`setLayerDescription(java.lang.String text)` Description for the layer.
`void`	`setLayerWeight(double layerWeight)` Default layer position.
`void`	`setMaskRasterDatasetByRef(IRasterDataset ppRasterDataset)` Reference to the current selection dataset.
`void`	`setMaximumScale(double maxScale)` Maximum scale (representative fraction) at which the layer will display.
`void`	`setMinimumScale(double minScale)` Minimum scale (representative fraction) at which the layer will display.
`void`	`setName(java.lang.String name)` Layer name.
`void`	`setPrimaryField(int pnField)` Layer's primary field.
`void`	`setPyramidPresent(boolean pbPyramidPresent)` Indicates if pyramids are present for the layer.
`void`	`setRelativeBase(java.lang.String basePath)` Base path used when storing relative path names.
`void`	`setRendererByRef(IRasterRenderer renderer)` Layer's renderer.
`void`	`setSelectionSetByRef(ISelectionSet selectionSet)` The selected set of rows.
`void`	`setShowResolution(boolean b)` Indicates if the raster resolution should be displayed in the Table of Contents.
`void`	`setShowTips(boolean show)` Indicates if the layer shows map tips.
`void`	`setSpatialReferenceByRef(ISpatialReference rhs1)` Spatial reference for the layer.
`void`	`setSupportsInteractive(boolean supported)` Indicates if the layer supports interactive effects changes.
`void`	`setSymbolsAreGraduated(boolean symbolsAreGraduated)` Indicates if symbols are graduated.
`void`	`setTemporary(boolean temporary)` Indicates if the layer is a temporary layer.
`void`	`setTransparency(short alpha)` Layer transparency in percent (0-100).
`void`	`setVisible(boolean visible)` Indicates if the layer is currently visible.
`void`	`setVisibleExtent(IEnvelope ppVisibleExtent)` Visible extent of the layer in the data frame.
`void`	`shift(double deltaX, double deltaY)` Shift operation of layer.
`void`	`twoPointsAdjust(IPointCollection fromPoints, IPointCollection toPoints)` Two points adjust operation of layer.
`ICursor`	`update(IQueryFilter queryFilter, boolean recycling)` Returns a cursor that can be used to update Rows selected by the specified query.
`void`	`updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer)` Update the Rows in the database selected by the specified query.
`void`	`warp(IPointCollection fromPoints, IPointCollection toPoints, int order)` Warp operation of layer.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterLayer

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

Constructs a RasterLayer using ArcGIS Engine.
Throws:: java.io.IOException - if there are interop problems; java.net.UnknownHostException - if there are interop problems

RasterLayer

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.; Construct a RasterLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterLayer.
RasterLayer theRasterLayer = (RasterLayer) obj;
Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: java.io.IOException - if there are interop problems

Method Detail