com.esri.arcgis.datasourcesraster
Class MultidimensionalInfo

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

All Implemented Interfaces:

IMosaicDatasetDefinitionObject, IMultidimensionalInfo, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class MultidimensionalInfo
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMultidimensionalInfo, IMosaicDatasetDefinitionObject, IXMLSerialize, IPersistStream, IPersist, IXMLVersionSupport, java.io.Externalizable

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

Description 'A class for the multidimensional info value object.' 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.datasourcesraster.IMultidimensionalInfo

IID, IID583c9454_50f0_4def_bad5_c9b39add39d2, xxDummy

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

IID, IIDb5dc8c12_261a_405b_80a8_39e192e1ca06, 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.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

MultidimensionalInfo()
Constructs a MultidimensionalInfo using ArcGIS Engine.

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

Method Summary

void	add(IMultidimensionalInfo pMdInfo) Adds to this object all information contained in the specified multidimensional info object.
void	addDimensionValue(java.lang.String bsDimensionName, java.lang.String bsVariableName, double minDimensionValue, double maxDimensionValue) Adds a new value range along the specified dimension associated with the specified variable.
java.lang.String	convertDimensionValueToString(java.lang.String bsDimensionName, java.lang.String bsVariableName, double dimensionValue) Returns an appropriate textual representation of the specified dimension value.
double	convertStringToDimensionValue(java.lang.String bsDimensionName, java.lang.String bsVariableName, java.lang.String bsDimensionStringValue) Returns the numeric form of the dimension value given it's textual representation.
void	defineDimension(java.lang.String bsDimensionName, java.lang.String bsVariableName, IPropertySet pDimensionAttributes) Defines a dimension associated with the specified variable using the dimension-specific attributes.
void	defineVariable(java.lang.String bsVariableName, IPropertySet pVariableAttributes) Defines a variable using the set of all associated attributes.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IPropertySet	getDimensionAttributes(java.lang.String bsDimensionName, java.lang.String bsVariableName) Returns the attributes corresponding to the specified dimension associated with the specified variable.
IStringArray	getDimensionNames(java.lang.String bsVariableName) The set of dimension names associated with the specified variable.
void	getDimensionValues(java.lang.String bsDimensionName, java.lang.String bsVariableName, IDoubleArray[] ppMinDimensionValues, IDoubleArray[] ppMaxDimensionValues) Returns the set of value ranges along the specified dimension associated with the specified variable.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IPropertySet	getVariableAttributes(java.lang.String bsVariableName) Returns the attributes associated with the specified variable.
IStringArray	getVariableNames() The set of all variable names.
int	hashCode() the hashcode for this object
boolean	isChanged() Indicates whether the contents of the object has changed since the last time this flag was reset.
void	isDirty() isDirty
void	load(IStream pstm) load
void	putDimensionValues(java.lang.String bsDimensionName, java.lang.String bsVariableName, IDoubleArray pMinDimensionValues, IDoubleArray pMaxDimensionValues) Sets the value ranges along the specified dimension associated with the specified variable.
void	readExternal(java.io.ObjectInput in)
void	release() Release a MultidimensionalInfo.
void	removeDimension(java.lang.String bsDimensionName, java.lang.String bsVariableName) Removes all attributes and values corresponding to the specified dimension associated with the specified variable.
void	removeVariable(java.lang.String bsVariableName) Removes all attributes, dimensions, and dimension values associated with the specified variable.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setChanged(boolean pbHasChanged) Indicates whether the contents of the object has changed since the last time this flag was reset.
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

MultidimensionalInfo

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

Constructs a MultidimensionalInfo using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MultidimensionalInfo

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

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

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

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

Specified by:

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

defineVariable

public void defineVariable(java.lang.String bsVariableName,
                           IPropertySet pVariableAttributes)
                    throws java.io.IOException,
                           AutomationException

Defines a variable using the set of all associated attributes. Overwrites the attributes if the variable has already been defined.

Specified by:

defineVariable in interface IMultidimensionalInfo

Parameters:

bsVariableName - The bsVariableName (in)

pVariableAttributes - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVariableAttributes

public IPropertySet getVariableAttributes(java.lang.String bsVariableName)
                                   throws java.io.IOException,
                                          AutomationException

Returns the attributes associated with the specified variable. Fails if the variable hasn't been defined.

Specified by:

getVariableAttributes in interface IMultidimensionalInfo

Parameters:

bsVariableName - The bsVariableName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeVariable

public void removeVariable(java.lang.String bsVariableName)
                    throws java.io.IOException,
                           AutomationException

Removes all attributes, dimensions, and dimension values associated with the specified variable.

Specified by:

removeVariable in interface IMultidimensionalInfo

Parameters:

bsVariableName - The bsVariableName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVariableNames

public IStringArray getVariableNames()
                              throws java.io.IOException,
                                     AutomationException

The set of all variable names.

Specified by:

getVariableNames in interface IMultidimensionalInfo

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

defineDimension

public void defineDimension(java.lang.String bsDimensionName,
                            java.lang.String bsVariableName,
                            IPropertySet pDimensionAttributes)
                     throws java.io.IOException,
                            AutomationException

Defines a dimension associated with the specified variable using the dimension-specific attributes. Overwrites the attributes if the dimension associated with specified variable has already been defined.

Specified by:

defineDimension in interface IMultidimensionalInfo

Parameters:

bsDimensionName - The bsDimensionName (in)

bsVariableName - The bsVariableName (in)

pDimensionAttributes - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDimensionAttributes

public IPropertySet getDimensionAttributes(java.lang.String bsDimensionName,
                                           java.lang.String bsVariableName)
                                    throws java.io.IOException,
                                           AutomationException

Returns the attributes corresponding to the specified dimension associated with the specified variable. Fails if the dimension associated with the variable hasn't been defined.

Specified by:

getDimensionAttributes in interface IMultidimensionalInfo

Parameters:

bsDimensionName - The bsDimensionName (in)

bsVariableName - The bsVariableName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeDimension

public void removeDimension(java.lang.String bsDimensionName,
                            java.lang.String bsVariableName)
                     throws java.io.IOException,
                            AutomationException

Removes all attributes and values corresponding to the specified dimension associated with the specified variable.

Specified by:

removeDimension in interface IMultidimensionalInfo

Parameters:

bsDimensionName - The bsDimensionName (in)

bsVariableName - The bsVariableName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putDimensionValues

public void putDimensionValues(java.lang.String bsDimensionName,
                               java.lang.String bsVariableName,
                               IDoubleArray pMinDimensionValues,
                               IDoubleArray pMaxDimensionValues)
                        throws java.io.IOException,
                               AutomationException

Sets the value ranges along the specified dimension associated with the specified variable. All previously defined values along this dimension associated with the specified variable are replaced. The argument pMaxDimensionValues may be null to indicate values ?G?^??

Specified by:

putDimensionValues in interface IMultidimensionalInfo

Parameters:

bsDimensionName - The bsDimensionName (in)

bsVariableName - The bsVariableName (in)

pMinDimensionValues - A reference to a com.esri.arcgis.system.IDoubleArray (in)

pMaxDimensionValues - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addDimensionValue

public void addDimensionValue(java.lang.String bsDimensionName,
                              java.lang.String bsVariableName,
                              double minDimensionValue,
                              double maxDimensionValue)
                       throws java.io.IOException,
                              AutomationException

Adds a new value range along the specified dimension associated with the specified variable. To indicate a point (and not an interval) along the dimension, ensure maxDimensionValue equals minDimensionValue.

Specified by:

addDimensionValue in interface IMultidimensionalInfo

Parameters:

bsDimensionName - The bsDimensionName (in)

bsVariableName - The bsVariableName (in)

minDimensionValue - The minDimensionValue (in)

maxDimensionValue - The maxDimensionValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDimensionValues

public void getDimensionValues(java.lang.String bsDimensionName,
                               java.lang.String bsVariableName,
                               IDoubleArray[] ppMinDimensionValues,
                               IDoubleArray[] ppMaxDimensionValues)
                        throws java.io.IOException,
                               AutomationException

Returns the set of value ranges along the specified dimension associated with the specified variable.

Specified by:

getDimensionValues in interface IMultidimensionalInfo

Parameters:

bsDimensionName - The bsDimensionName (in)

bsVariableName - The bsVariableName (in)

ppMinDimensionValues - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

ppMaxDimensionValues - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertDimensionValueToString

public java.lang.String convertDimensionValueToString(java.lang.String bsDimensionName,
                                                      java.lang.String bsVariableName,
                                                      double dimensionValue)
                                               throws java.io.IOException,
                                                      AutomationException

Returns an appropriate textual representation of the specified dimension value.

Specified by:

convertDimensionValueToString in interface IMultidimensionalInfo

Parameters:

bsDimensionName - The bsDimensionName (in)

bsVariableName - The bsVariableName (in)

dimensionValue - The dimensionValue (in)

Returns:

The pbsDimensionStringValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertStringToDimensionValue

public double convertStringToDimensionValue(java.lang.String bsDimensionName,
                                            java.lang.String bsVariableName,
                                            java.lang.String bsDimensionStringValue)
                                     throws java.io.IOException,
                                            AutomationException

Returns the numeric form of the dimension value given it's textual representation.

Specified by:

convertStringToDimensionValue in interface IMultidimensionalInfo

Parameters:

bsDimensionName - The bsDimensionName (in)

bsVariableName - The bsVariableName (in)

bsDimensionStringValue - The bsDimensionStringValue (in)

Returns:

The pDimensionValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDimensionNames

public IStringArray getDimensionNames(java.lang.String bsVariableName)
                               throws java.io.IOException,
                                      AutomationException

The set of dimension names associated with the specified variable.

Specified by:

getDimensionNames in interface IMultidimensionalInfo

Parameters:

bsVariableName - The bsVariableName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(IMultidimensionalInfo pMdInfo)
         throws java.io.IOException,
                AutomationException

Adds to this object all information contained in the specified multidimensional info object.

Specified by:

add in interface IMultidimensionalInfo

Parameters:

pMdInfo - A reference to a com.esri.arcgis.datasourcesraster.IMultidimensionalInfo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isChanged

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

Indicates whether the contents of the object has changed since the last time this flag was reset.

Specified by:

isChanged in interface IMosaicDatasetDefinitionObject

Returns:

The pbHasChanged

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setChanged

public void setChanged(boolean pbHasChanged)
                throws java.io.IOException,
                       AutomationException

Indicates whether the contents of the object has changed since the last time this flag was reset.

Specified by:

setChanged in interface IMosaicDatasetDefinitionObject

Parameters:

pbHasChanged - The pbHasChanged (in)

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.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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