com.esri.arcgis.datasourcesraster
Interface IMultidimensionalInfo

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMultidimensionalInfoProxy, MultidimensionalInfo

public interface IMultidimensionalInfo
extends java.io.Serializable

COM Interface 'IMultidimensionalInfo'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control a 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID583c9454_50f0_4def_bad5_c9b39add39d2
static int	xxDummy Deprecated. Internal use only

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.
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.
IPropertySet	getVariableAttributes(java.lang.String bsVariableName) Returns the attributes associated with the specified variable.
IStringArray	getVariableNames() The set of all variable names.
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	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.

Field Detail

IID583c9454_50f0_4def_bad5_c9b39add39d2

static final int IID583c9454_50f0_4def_bad5_c9b39add39d2

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

defineVariable

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.

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

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.

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

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

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

Parameters:

bsVariableName - The bsVariableName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVariableNames

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

The set of all variable names.

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

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.

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

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.

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

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.

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

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?^??

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

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.

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

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.

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

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.

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

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.

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

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

The set of dimension names associated with the specified variable.

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

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

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

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.