com.esri.arcgis.geoprocessing
Class GPMosaicLayer

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GPMosaicLayer
All Implemented Interfaces:
IGPLayer, IDEGeoDataset, IGPDescribe, IGPValue, IGPCompositeLayer, IGPMosaicLayer, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPMosaicLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPValue, IGPMosaicLayer, IGPCompositeLayer, IGPDescribe, IClone, IXMLSerialize, IPersistStream, IGPLayer, IDEGeoDataset, java.io.Externalizable

COM Class 'GPMosaicLayer'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'Geoprocessing Mosaic Layer Value.' 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue
IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy
 
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPMosaicLayer
IID, IIDa4f784e6_b91e_49fa_aec5_e7f185636352, xxDummy
 
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPCompositeLayer
IID, IID0bcc2e79_557e_4070_b876_f3928533830f, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IClone
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.datasourcesfile.IGPLayer
IID, IIDea30b18d_2d75_4593_bf44_b3620f41d8db, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDEGeoDataset
IID, IID5ed64e50_a2f2_11d5_931b_0080c71a3226, xxDummy
 
Constructor Summary
GPMosaicLayer()
          Constructs a GPMosaicLayer using ArcGIS Engine.
GPMosaicLayer(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPMosaicLayer theGPMosaicLayer = (GPMosaicLayer) obj;
 
Method Summary
 void add(IGPLayer pGPLayer)
          Add a layer.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void clear()
          Remove all layers.
 java.lang.Object describe(java.lang.String name)
          The description of the named object.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void empty()
          Clears the value object.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 IEnvelope getAreaOfInterest()
          The default area of interest for the layer.
 java.lang.String getAsText()
          Provides the value of the value object.
 IArray getChildren()
          Returns the array of layers.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 int getCount()
          Gets the number of layers.
 IDataElement getDataElement()
          The data element of the layer.
 IEnvelope getExtent()
          The extent of the coverage.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IGPLayer getLayer(int index)
          Returns a given layer.
 java.lang.String getNameString()
          The name string.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ISpatialReference getSpatialReference()
          The spatial reference of the geodataset.
 int hashCode()
          the hashcode for this object
 IGPDataType IGPValue_getDataType()
          The data type of the value object.
 void isDirty()
          isDirty
 boolean isEmpty()
          Indicates if the value object is empty.
 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.
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a GPMosaicLayer.
 void remove(int index)
          Remove a layer.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAOICoords(double xMin, double yMin, double xMax, double yMax)
          The set Extent of the feature layer.
 void setAreaOfInterestByRef(IEnvelope ppExtent)
          The default area of interest for the layer.
 IGPMessage setAsText(java.lang.String text)
          Provides the value of the value object with the given string value.
 void setDataElementByRef(IDataElement ppDataElement)
          The data element of the layer.
 void setExtentByRef(IEnvelope extent)
          The extent of the coverage.
 void setNameString(java.lang.String pNamestring)
          The name string.
 void setSpatialReferenceByRef(ISpatialReference spatialReference)
          The spatial reference of the geodataset.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

GPMosaicLayer

public GPMosaicLayer()
              throws java.io.IOException,
                     java.net.UnknownHostException
Constructs a GPMosaicLayer using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GPMosaicLayer

public GPMosaicLayer(java.lang.Object obj)
              throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPMosaicLayer theGPMosaicLayer = (GPMosaicLayer) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException
The data type of the value object.

Specified by:
IGPValue_getDataType in interface IGPValue
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDataType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException
Indicates if the value object is empty.

Specified by:
isEmpty in interface IGPValue
Returns:
The isEmpty
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws java.io.IOException,
                  AutomationException
Clears the value object.

Specified by:
empty in interface IGPValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsText

public java.lang.String getAsText()
                           throws java.io.IOException,
                                  AutomationException
Provides the value of the value object.

Specified by:
getAsText in interface IGPValue
Returns:
The text
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException
Provides the value of the value object with the given string value.

Specified by:
setAsText in interface IGPValue
Parameters:
text - The text (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
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
Gets the number of layers.

Specified by:
getCount in interface IGPCompositeLayer
Returns:
The pCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public IGPLayer getLayer(int index)
                  throws java.io.IOException,
                         AutomationException
Returns a given layer.

Specified by:
getLayer in interface IGPCompositeLayer
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.datasourcesfile.IGPLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IGPLayer pGPLayer)
         throws java.io.IOException,
                AutomationException
Add a layer.

Specified by:
add in interface IGPCompositeLayer
Parameters:
pGPLayer - A reference to a com.esri.arcgis.datasourcesfile.IGPLayer (in)
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
Remove a layer.

Specified by:
remove in interface IGPCompositeLayer
Parameters:
index - The index (in)
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
Remove all layers.

Specified by:
clear in interface IGPCompositeLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildren

public IArray getChildren()
                   throws java.io.IOException,
                          AutomationException
Returns the array of layers.

Specified by:
getChildren in interface IGPCompositeLayer
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

describe

public java.lang.Object describe(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException
The description of the named object.

Product Availability

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

Specified by:
describe in interface IGPDescribe
Parameters:
name - The name (in)
Returns:
A Variant
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.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

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

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException
The name string.

Specified by:
getNameString in interface IGPLayer
Returns:
The pNamestring
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNameString

public void setNameString(java.lang.String pNamestring)
                   throws java.io.IOException,
                          AutomationException
The name string.

Specified by:
setNameString in interface IGPLayer
Parameters:
pNamestring - The pNamestring (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException
The default area of interest for the layer.

Specified by:
getAreaOfInterest in interface IGPLayer
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.

setAreaOfInterestByRef

public void setAreaOfInterestByRef(IEnvelope ppExtent)
                            throws java.io.IOException,
                                   AutomationException
The default area of interest for the layer.

Specified by:
setAreaOfInterestByRef in interface IGPLayer
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.

setAOICoords

public void setAOICoords(double xMin,
                         double yMin,
                         double xMax,
                         double yMax)
                  throws java.io.IOException,
                         AutomationException
The set Extent of the feature layer.

Specified by:
setAOICoords in interface IGPLayer
Parameters:
xMin - The xMin (in)
yMin - The yMin (in)
xMax - The xMax (in)
yMax - The yMax (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataElement

public IDataElement getDataElement()
                            throws java.io.IOException,
                                   AutomationException
The data element of the layer.

Specified by:
getDataElement in interface IGPLayer
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataElementByRef

public void setDataElementByRef(IDataElement ppDataElement)
                         throws java.io.IOException,
                                AutomationException
The data element of the layer.

Specified by:
setDataElementByRef in interface IGPLayer
Parameters:
ppDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (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 coverage.

Specified by:
getExtent in interface IDEGeoDataset
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.

setExtentByRef

public void setExtentByRef(IEnvelope extent)
                    throws java.io.IOException,
                           AutomationException
The extent of the coverage.

Specified by:
setExtentByRef in interface IDEGeoDataset
Parameters:
extent - 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.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The spatial reference of the geodataset.

Specified by:
getSpatialReference in interface IDEGeoDataset
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.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialReference)
                              throws java.io.IOException,
                                     AutomationException
The spatial reference of the geodataset.

Specified by:
setSpatialReferenceByRef in interface IDEGeoDataset
Parameters:
spatialReference - 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.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException