com.esri.arcgis.carto.WMTSLayer
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class WMTSLayer
Provides programmatic access to WMTS layer.
| Constructor Summary | |
|---|---|
WMTSLayer()
Constructs a WMTSLayer using ArcGIS Engine. |
|
WMTSLayer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. WMTSLayer theWMTSLayer = (WMTSLayer) obj; |
|
| Method Summary | |
|---|---|
void |
addExtension(Object ext)
Adds a new extension. |
void |
addILayerEventsListener(ILayerEvents theListener)
addILayerEventsListener. |
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 |
clearPassword(boolean bForceReconnect)
Removes the passwords from the layer used to access data, and forces a reconnection to the data. |
boolean |
connect(IName pConnectionName)
Connects to a WMTS Connection Name |
IDataset |
copy(String copyName,
IWorkspace copyWorkspace)
Copies this dataset to a new dataset with the specified name. |
void |
delete()
Deletes this dataset. |
void |
draw(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
Draws the layer to the specified display for the given draw phase. |
boolean |
equals(Object o)
Compare this object with another |
IEnvelope |
getAreaOfInterest()
The default area of interest for the layer. |
short |
getBrightness()
Layer brightness in percent (-100 - 100). |
String |
getBrowseName()
The browse name of the dataset. |
String |
getCategory()
The category of the dataset. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
short |
getContrast()
Layer contrast in percent (-100 - 100). |
String |
getDataDetails(String bsPadding)
Details of the layer's data. |
IName |
getDataSourceName()
WMTS Connection Name. |
IPropertySet |
getDimensions()
Values for the avialble dimensions in WMTS Layer. |
ISelectionSet |
getDisplaySelectionSet()
The selected set of rows from the display table. |
ITable |
getDisplayTable()
The display table. |
Object |
getExtension(int index)
The extension at the specified index. |
int |
getExtensionCount()
Number of extensions. |
IEnvelope |
getExtent()
The extent of the GeoDataset. |
IName |
getFullName()
The associated name object. |
String |
getImageFormat()
Image format. |
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. |
String |
getLayerName()
Layer name in a WMTS Service. |
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. |
double |
getMaximumScale()
Maximum scale (representative fraction) at which the layer will display. |
double |
getMinimumScale()
Minimum scale (representative fraction) at which the layer will display. |
String |
getName()
Layer name. |
IPropertySet |
getPropertySet()
The set of properties for the dataset. |
String |
getPublishingDescription()
The layer description reported to the publisher. |
String |
getRelativeBase()
Base path used when storing relative path names. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
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. |
String |
getStyle()
Style from WMTS Layer. |
IEnumDataset |
getSubsets()
Datasets contained within this dataset. |
int |
getSupportedDrawPhases()
Supported draw phases. |
String |
getTileMatrixSet()
TileMatrixSet to be used by the service. |
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. |
void |
getWMTSConnection(IWMTSConnection pConnection)
WMTS Connection. |
IWorkspace |
getWorkspace()
The workspace containing this dataset. |
int |
hashCode()
the hashcode for this object |
String |
ILayerGeneralProperties_getLayerDescription()
Description for the layer. |
boolean |
isCached()
Indicates if the layer needs its own display cache. |
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()
isDirty |
boolean |
isDoesBlending()
Indicates whether the drawing object blends its output with the background. |
boolean |
isDrawingPropsDirty()
Indicates if the layer drawing properties are dirty. |
boolean |
isHasAuthentication()
Indicates if the layer is password protected. |
boolean |
isRequiresBanding()
Indicates whether the output from the drawing object requires banding. |
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 |
isUsesFilter()
Indicates if the current object draws using a display filter. |
boolean |
isValid()
Indicates if the layer is currently valid. |
boolean |
isVisible()
Indicates if the layer is currently visible. |
void |
load(IStream pstm)
load |
void |
prepareForPublishing()
Prepare the layer for the publishing process. |
void |
readExternal(ObjectInput in)
|
void |
removeExtension(int index)
Removes the specified extension. |
void |
removeILayerEventsListener(ILayerEvents theListener)
removeILayerEventsListener. |
void |
rename(String name)
Renames this Dataset. |
void |
save(IStream pstm,
int fClearDirty)
save |
ICursor |
searchDisplayTable(IQueryFilter pQueryFilter,
boolean recycling)
Creates a cursor from the display table based upon the search criteria. |
ISelectionSet |
selectDisplayTable(IQueryFilter pQueryFilter,
int selType,
int selOption,
IWorkspace pSelWorkspace)
Creates a selection set from the display table based upon the search criteria. |
void |
setBrightness(short brightnessValue)
Layer brightness in percent (-100 - 100). |
void |
setBrowseName(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 ppConnectionName)
WMTS Connection Name. |
void |
setDimensions(IPropertySet dimensions)
Values for the avialble dimensions in WMTS Layer. |
void |
setDrawingPropsDirty(boolean dirty)
Indicates if the layer drawing properties are dirty. |
void |
setImageFormat(String imageFormat)
Image format. |
void |
setLayerDescription(String text)
Description for the layer. |
void |
setLayerWeight(double layerWeight)
Default layer position. |
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(String name)
Layer name. |
void |
setRelativeBase(String basePath)
Base path used when storing relative path names. |
void |
setShowTips(boolean show)
Indicates if the layer shows map tips. |
void |
setSpatialReferenceByRef(ISpatialReference rhs1)
Spatial reference for the layer. |
void |
setStyle(String styleName)
Style from WMTS Layer. |
void |
setSupportsInteractive(boolean supported)
Indicates if the layer supports interactive effects changes. |
void |
setSymbolsAreGraduated(boolean symbolsAreGraduated)
Indicates if symbols are graduated. |
void |
setTileMatrixSet(String tileMatrix)
TileMatrixSet to be used by the service. |
void |
setTransparency(short alpha)
Layer transparency in percent (0-100). |
void |
setVisible(boolean visible)
Indicates if the layer is currently visible. |
void |
writeExternal(ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public WMTSLayer()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public WMTSLayer(Object obj)
throws IOException
WMTSLayer theWMTSLayer = (WMTSLayer) obj;
obj to WMTSLayer.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void addILayerEventsListener(ILayerEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
IOException - If there are communications problems.
public void removeILayerEventsListener(ILayerEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
IOException - If there are communications problems.
public boolean connect(IName pConnectionName)
throws IOException,
AutomationException
connect in interface IDataLayerconnect in interface IWMTSLayerpConnectionName - A reference to a com.esri.arcgis.system.IName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getDataSourceName()
throws IOException,
AutomationException
getDataSourceName in interface IDataLayergetDataSourceName in interface IWMTSLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDataSourceName(IName ppConnectionName)
throws IOException,
AutomationException
setDataSourceName in interface IDataLayersetDataSourceName in interface IWMTSLayerppConnectionName - A reference to a com.esri.arcgis.system.IName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getWMTSConnection(IWMTSConnection pConnection)
throws IOException,
AutomationException
getWMTSConnection in interface IWMTSLayerpConnection - A reference to a com.esri.arcgis.gisclient.IWMTSConnection (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getLayerName()
throws IOException,
AutomationException
getLayerName in interface IWMTSLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDimensions(IPropertySet dimensions)
throws IOException,
AutomationException
setDimensions in interface IWMTSLayerdimensions - A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getDimensions()
throws IOException,
AutomationException
getDimensions in interface IWMTSLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTileMatrixSet(String tileMatrix)
throws IOException,
AutomationException
setTileMatrixSet in interface IWMTSLayertileMatrix - The tileMatrix (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTileMatrixSet()
throws IOException,
AutomationException
getTileMatrixSet in interface IWMTSLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getImageFormat()
throws IOException,
AutomationException
getImageFormat in interface IWMTSLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setImageFormat(String imageFormat)
throws IOException,
AutomationException
setImageFormat in interface IWMTSLayerimageFormat - The imageFormat (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setStyle(String styleName)
throws IOException,
AutomationException
setStyle in interface IWMTSLayerstyleName - The styleName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getStyle()
throws IOException,
AutomationException
getStyle in interface IWMTSLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getName()
throws IOException,
AutomationException
Use this property to associate a string with a layer.
getName in interface ILayergetName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(String name)
throws IOException,
AutomationException
setName in interface ILayername - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isValid()
throws IOException,
AutomationException
The valid property indicates if the layer is currently valid. Layers that reference feature classes are valid when they hold a reference to a valid feature class. The property does not however validate the integrity of the feature classes reference to the database. Therefore, in rare situations if a datasource is removed after a layer is initialized, the layer will report itself as valid but query attempts to the data source will error due to the lack of underlying data.
isValid in interface ILayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getAreaOfInterest()
throws IOException,
AutomationException
Returns the spatial-referenced extent of the layer.
getAreaOfInterest in interface ILayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getMinimumScale()
throws IOException,
AutomationException
Specifies the minimum scale at which the layer will be displayed. This means that if you zoom out beyond this scale, the layer will not display. For example, specify 1000 to have the layer not display when zoomed out beyond 1:1000.
getMinimumScale in interface ILayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMinimumScale(double minScale)
throws IOException,
AutomationException
setMinimumScale in interface ILayerminScale - The minScale (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getMaximumScale()
throws IOException,
AutomationException
Specifies the maximum scale at which the layer will be displayed. This means that if you zoom in beyond this scale, the layer will not display. For example, specify 500 to have the layer not display when zoomed in beyond 1:500.
getMaximumScale in interface ILayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMaximumScale(double maxScale)
throws IOException,
AutomationException
setMaximumScale in interface ILayermaxScale - The maxScale (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isVisible()
throws IOException,
AutomationException
isVisible in interface ILayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setVisible(boolean visible)
throws IOException,
AutomationException
setVisible in interface ILayervisible - The visible (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isShowTips()
throws IOException,
AutomationException
Indicates whether or not map tips are shown for the layer. If set to True, then map tips will be shown for the layer. You can determine the text that will be shown via TipText. For a FeatureLayer, this text comes from the data for IFeatureLayer::DisplayField.
isShowTips in interface ILayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setShowTips(boolean show)
throws IOException,
AutomationException
setShowTips in interface ILayershow - The show (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTipText(double x,
double y,
double tolerance)
throws IOException,
AutomationException
getTipText in interface ILayerx - The x (in)y - The y (in)tolerance - The tolerance (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCached()
throws IOException,
AutomationException
This property indicates whether or not the layer requires its own display cache. If this property is True, then the Map will use a separate display cache for the layer so that it can be refreshed indpendently of other layers.
The Map is responsible for cache management. See IScreenDisplay::AddCache for more information on caches.
isCached in interface ILayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCached(boolean cached)
throws IOException,
AutomationException
Informational property. Container is responsible for cache management.
setCached in interface ILayercached - The cached (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSupportedDrawPhases()
throws IOException,
AutomationException
Indicates the draw phases supported by the layer (esriDPGeography, esriDPAnnotation, esriDPSelection, or any combination of the three). The supported draw phases are defined by esriDrawPhase. When multiple draw phases are supported, the sum of the constants is used. For example, if SupportedDrawPhases = 3 then the layer supports drawing in the geography and annotation phases.
getSupportedDrawPhases in interface ILayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSpatialReferenceByRef(ISpatialReference rhs1)
throws IOException,
AutomationException
This property is only used for map display, setting this property does not change the spatial reference of the layer's underlying data. The ArcGIS framework uses this property to pass the spatial reference from the map to the layer in order to support on-the-fly projection.
setSpatialReferenceByRef in interface ILayerrhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void draw(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
throws IOException,
AutomationException
This method draws the layer to the Display for the specified DrawPhase. Use the TrackCancel object to allow the drawing of the layer to be interrupted by the user.
draw in interface ILayerdrawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)display - A reference to a com.esri.arcgis.display.IDisplay (in)trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISpatialReference getSpatialReference()
throws IOException,
AutomationException
This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.
Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.
Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.
getSpatialReference in interface IGeoDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getExtent()
throws IOException,
AutomationException
The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.
Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.
If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.
If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.
ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.
getExtent in interface IGeoDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDrawingPropsDirty()
throws IOException,
AutomationException
isDrawingPropsDirty in interface ILayerDrawingPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDrawingPropsDirty(boolean dirty)
throws IOException,
AutomationException
setDrawingPropsDirty in interface ILayerDrawingPropertiesdirty - The dirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportsTransparency()
throws IOException,
AutomationException
isSupportsTransparency in interface ILayerEffectsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportsContrastChange()
throws IOException,
AutomationException
isSupportsContrastChange in interface ILayerEffectsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportsBrightnessChange()
throws IOException,
AutomationException
isSupportsBrightnessChange in interface ILayerEffectsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSupportsInteractive(boolean supported)
throws IOException,
AutomationException
setSupportsInteractive in interface ILayerEffectssupported - The supported (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportsInteractive()
throws IOException,
AutomationException
isSupportsInteractive in interface ILayerEffectsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public short getTransparency()
throws IOException,
AutomationException
When
you set Transparency for a
FeatureLayer, a
TransparencyDisplayFilter is created and applied
to the layer. You can accomplish the same effect by manually
creating a new TransparencyDisplayFilter using IDisplayFilter, and
then assigning it to a layer using
IDisplayFilterManager.
getTransparency in interface ILayerEffectsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTransparency(short alpha)
throws IOException,
AutomationException
setTransparency in interface ILayerEffectsalpha - The alpha (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public short getContrast()
throws IOException,
AutomationException
getContrast in interface ILayerEffectsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setContrast(short contrastValue)
throws IOException,
AutomationException
setContrast in interface ILayerEffectscontrastValue - The contrastValue (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public short getBrightness()
throws IOException,
AutomationException
getBrightness in interface ILayerEffectsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBrightness(short brightnessValue)
throws IOException,
AutomationException
setBrightness in interface ILayerEffectsbrightnessValue - The brightnessValue (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSmallImage()
throws IOException,
AutomationException
The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.
getSmallImage in interface ILayerInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSmallSelectedImage()
throws IOException,
AutomationException
The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.
getSmallSelectedImage in interface ILayerInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLargeImage()
throws IOException,
AutomationException
The icon used to represent the layer in ArcCatalog's 'Large Icon' view.
getLargeImage in interface ILayerInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLargeSelectedImage()
throws IOException,
AutomationException
The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.
getLargeSelectedImage in interface ILayerInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getLastMinimumScale()
throws IOException,
AutomationException
getLastMinimumScale in interface ILayerGeneralPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getLastMaximumScale()
throws IOException,
AutomationException
getLastMaximumScale in interface ILayerGeneralPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String ILayerGeneralProperties_getLayerDescription()
throws IOException,
AutomationException
ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLayerDescription(String text)
throws IOException,
AutomationException
setLayerDescription in interface ILayerGeneralPropertiestext - The text (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getExtensionCount()
throws IOException,
AutomationException
getExtensionCount in interface ILayerExtensionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getExtension(int index)
throws IOException,
AutomationException
getExtension in interface ILayerExtensionsindex - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addExtension(Object ext)
throws IOException,
AutomationException
addExtension in interface ILayerExtensionsext - A reference to another Object (IUnknown) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeExtension(int index)
throws IOException,
AutomationException
removeExtension in interface ILayerExtensionsindex - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable getDisplayTable()
throws IOException,
AutomationException
getDisplayTable in interface IDisplayTableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor searchDisplayTable(IQueryFilter pQueryFilter,
boolean recycling)
throws IOException,
AutomationException
QueryFilter specifies an IQueryFilterObject to be used for the search.
Recycling specifies whether the resulting cursor is recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor.
If there is a definition query set on the layer or table, the SearchDisplayTable method will work on the subset of rows that meet the definition criteria. Otherwise, it will search the whole table.
SearchDisplayTable will return an ICursor with all of the rows that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the cursor will have all of the rows from the table.
This SearchDisplayTable method will also work on joined fields if you qualify the field names. For example, if you want to search a field called "Pop1990" from a joined table called "Demog", you should used "Demog.Pop1990" for the field name in the query filter used in the search method.
The Recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single row object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a row object returned by a recycling cursor across multiple calls to NextRow on the cursor. Row objects returned by a recycling cursor should not be modified.
Non-recycling cursors return a separate row object on each fetch. The objects returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The geodatabase guarantees 'unique instance semantics' on non-recycling feature objects fetched during an edit session.
Recycling cursors should be used only for drawing and read-only access to object state. Use non-recycling search cursors to fetch objects that are to be updated.
searchDisplayTable in interface IDisplayTablepQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter,
int selType,
int selOption,
IWorkspace pSelWorkspace)
throws IOException,
AutomationException
selectDisplayTable in interface IDisplayTablepQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)pSelWorkspace - 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 ISelectionSet getDisplaySelectionSet()
throws IOException,
AutomationException
getDisplaySelectionSet in interface IDisplayTableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getFullName()
throws IOException,
AutomationException
getFullName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getBrowseName()
throws IOException,
AutomationException
getBrowseName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBrowseName(String name)
throws IOException,
AutomationException
setBrowseName in interface IDatasetname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getType()
throws IOException,
AutomationException
// Assume we have a reference to an IfeatureClass (pFeatureClass) IDataset pDataset = null;
pDataset = new IDatasetProxy(pFeatureClass);
System.out.println(pDataset.getName() + " " + pDataset.getType());
if(pFeatureClass != null){
pDataset = pFeatureClass.getFeatureDataset();
System.out.println(pDataset.getName() + " " + pDataset.getType());
}
pDataset = new IDatasetProxy(pDataset.getWorkspace());
System.out.println(pDataset.getName() + " " +
pDataset.getType());
getType in interface IDatasetIOException - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canCopy()
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.
The CanCopy method is supported by:
canCopy in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDataset copy(String copyName,
IWorkspace copyWorkspace)
throws IOException,
AutomationException
IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.
copy in interface IDatasetcopyName - 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 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetIOException - 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 IDatasetname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDataSourceSupported(IName name)
throws IOException,
AutomationException
isDataSourceSupported in interface IDataLayername - A reference to a com.esri.arcgis.system.IName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getRelativeBase()
throws IOException,
AutomationException
The RelativeBase property is used internally when persisting and loading documents with a relative path. When a document has been fully loaded the path is realized to a complete path.
getRelativeBase in interface IDataLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRelativeBase(String basePath)
throws IOException,
AutomationException
setRelativeBase in interface IDataLayerbasePath - The basePath (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLegendGroupCount()
throws IOException,
AutomationException
The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.
getLegendGroupCount in interface ILegendInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILegendGroup getLegendGroup(int index)
throws IOException,
AutomationException
getLegendGroup in interface ILegendInfoindex - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILegendItem getLegendItem()
throws IOException,
AutomationException
Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.
getLegendItem in interface ILegendInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSymbolsAreGraduated()
throws IOException,
AutomationException
Indicates whether the symbols used for a layer or renderer's legend vary by size.
For example the proportional symbol renderer returns True for this property.
You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.
isSymbolsAreGraduated in interface ILegendInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
throws IOException,
AutomationException
setSymbolsAreGraduated in interface ILegendInfosymbolsAreGraduated - The symbolsAreGraduated (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getLayerWeight()
throws IOException,
AutomationException
The LayerWeight property defines the weight of the layer in the auto arrange order. During auto arrange, the higher weight layers are added to the map first, which means they draw lower in the draw order.
Default weights for layers are these values:
Annotation layers = 97
Points layers = 98
Polyline layers = 99
Polygon Layers = 100
getLayerWeight in interface ILayerPositionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLayerWeight(double layerWeight)
throws IOException,
AutomationException
setLayerWeight in interface ILayerPositionlayerWeight - The layerWeight (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUsesFilter()
throws IOException,
AutomationException
The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.
isUsesFilter in interface IDisplayAdmin2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isRequiresBanding()
throws IOException,
AutomationException
isRequiresBanding in interface IDisplayAdmin2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDoesBlending()
throws IOException,
AutomationException
isDoesBlending in interface IDisplayAdmin2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportsPublishing()
throws IOException,
AutomationException
isSupportsPublishing in interface IPublishLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getPublishingDescription()
throws IOException,
AutomationException
getPublishingDescription in interface IPublishLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDataValid()
throws IOException,
AutomationException
isDataValid in interface IPublishLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getDataDetails(String bsPadding)
throws IOException,
AutomationException
getDataDetails in interface IPublishLayerbsPadding - The bsPadding (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void prepareForPublishing()
throws IOException,
AutomationException
prepareForPublishing in interface IPublishLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void clearPassword(boolean bForceReconnect)
throws IOException,
AutomationException
clearPassword in interface ISecureLayerclearPassword in interface ISecureLayer2bForceReconnect - The bForceReconnect (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isHasAuthentication()
throws IOException,
AutomationException
isHasAuthentication in interface ISecureLayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||