com.esri.arcgis.carto
Interface ITimeDimensionDefinition

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadastralFabricSubLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, RasterLayer, StandaloneTable

public interface ITimeDimensionDefinition
extends Serializable

Provides access to properties that define time based on multi-dimensional data.

Description

Layer types that support multidimensional data can choose to define their definition of time based on the dimension. Implementing this interface will allow the users to set one of the dimensions as time dimension.

Product Availability

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

Method Summary

String	getTimeDimensionFormat() Returns the format of the dimension that represents time.
String	getTimeDimensionName() Returns the name of the dimension that represents time.
ITimeReference	getTimeReference() Time reference for the data.
boolean	isMultiDimensional() Indicates whether the data is multi-dimensional.
void	setTimeDimensionFormat(String format) Returns the format of the dimension that represents time.
void	setTimeDimensionName(String fieldName) Returns the name of the dimension that represents time.
void	setTimeReferenceByRef(ITimeReference nativeTimeReference) Time reference for the data.

Method Detail

isMultiDimensional

boolean isMultiDimensional()
                           throws IOException,
                                  AutomationException

Indicates whether the data is multi-dimensional.

Product Availability

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

Returns:

The isMultidimensional

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeDimensionName

String getTimeDimensionName()
                            throws IOException,
                                   AutomationException

Returns the name of the dimension that represents time.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeDimensionName

void setTimeDimensionName(String fieldName)
                          throws IOException,
                                 AutomationException

Returns the name of the dimension that represents time.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeDimensionFormat

String getTimeDimensionFormat()
                              throws IOException,
                                     AutomationException

Returns the format of the dimension that represents time.

Product Availability

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

Returns:

The format

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeDimensionFormat

void setTimeDimensionFormat(String format)
                            throws IOException,
                                   AutomationException

Returns the format of the dimension that represents time.

Product Availability

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

Parameters:

format - The format (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

Time reference for the data.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

void setTimeReferenceByRef(ITimeReference nativeTimeReference)
                           throws IOException,
                                  AutomationException

Time reference for the data.

Product Availability

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

Parameters:

nativeTimeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.