com.esri.arcgis.trackinganalyst
Interface ITemporalLayer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ITemporalLayer3

All Known Implementing Classes:

ITemporalLayer3Proxy, ITemporalLayerProxy, TemporalFeatureLayer

public interface ITemporalLayer
extends java.io.Serializable

COM Interface 'ITemporalLayer'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties and methods needed to manage temporal layer functionality.' 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	IID78c7430c_17cf_11d5_b7cf_00010265adc5
static int	xxDummy Deprecated. Internal use only

Method Summary

void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
IActionCollection	getActionCollection() The collection of action objects for this temporal layer.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
java.lang.String	getEventIDFieldName() Indicates the field containing the EventID information for the data.
int	getFeatureCacheWindow() Determines the number of features to cache if the CacheFeatures property is true.
double	getMaximumScale() Maximum scale (representative fraction) at which the layer will display.
double	getMinimumScale() Minimum scale (representative fraction) at which the layer will display.
java.lang.String	getName() Layer name.
int	getRelativeTimeColor() Indicates a relative color differential based on temporal class characteristics.
ITemporalOperator	getRelativeTimeOperator() The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.
IFeatureRenderer	getRenderer() Controls the temporal renderer for the layer.
int	getSupportedDrawPhases() Supported draw phases.
java.lang.String	getTemporalFieldName() Identifies the temporal field, which must be a field type with data that can be converted to a date value.
ITemporalLegendGroup	getTemporalLegendGroup() Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.
ITemporalReference	getTemporalReference() Defines the reference in time used to draw, identify, or perform other layer-based activities.
java.lang.String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
boolean	isCached() Indicates if the layer needs its own display cache.
boolean	isCacheFeatures() Controls whether Features are cached in the renderer's feature memory or are read from the feature class.
boolean	isDisplayFutureEvents() Indicates whether or not to display future events for a real-time data layer.
boolean	isDisplayOnlyLastKnownEvent() Indicates whether to display only the last known temporal event or all events in a layer.
boolean	isShowTips() Indicates if the layer shows map tips.
boolean	isValid() Indicates if the layer is currently valid.
boolean	isVisible() Indicates if the layer is currently visible.
void	processActions(boolean bvarResetActions) Apply the actions, contained in the action collection, to this temporal layer.
void	queryTemporalExtent(java.lang.Object[] pvarStartTime, java.lang.Object[] pvarEndTime) Obtain the start and end temporal values of the temporal layer's features.
void	setActionCollectionByRef(IActionCollection pVal) The collection of action objects for this temporal layer.
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setCacheFeatures(boolean pbAreFeaturesCached) Controls whether Features are cached in the renderer's feature memory or are read from the feature class.
void	setDisplayFutureEvents(boolean pbvarFutureEvents) Indicates whether or not to display future events for a real-time data layer.
void	setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent) Indicates whether to display only the last known temporal event or all events in a layer.
void	setFeatureCacheWindow(int pnPercent) Determines the number of features to cache if the CacheFeatures property is true.
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(java.lang.String name) Layer name.
void	setRelativeTimeColor(int pVal) Indicates a relative color differential based on temporal class characteristics.
void	setRelativeTimeOperator(ITemporalOperator pVal) The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.
void	setRendererByRef(IFeatureRenderer renderer) Controls the temporal renderer for the layer.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup) Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.
void	setTemporalReferenceByRef(ITemporalReference ppiTemporalReference) Defines the reference in time used to draw, identify, or perform other layer-based activities.
void	setVisible(boolean visible) Indicates if the layer is currently visible.
void	suspendIndexing(boolean bvarSuspend) This method suspends or resumes indexing on a temporal layer.

Field Detail

IID78c7430c_17cf_11d5_b7cf_00010265adc5

static final int IID78c7430c_17cf_11d5_b7cf_00010265adc5

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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Layer name.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Layer name.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

boolean isValid()
                throws java.io.IOException,
                       AutomationException

Indicates if the layer is currently valid.

Returns:

The valid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException

The default area of interest for the layer.

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.

getMinimumScale

double getMinimumScale()
                       throws java.io.IOException,
                              AutomationException

Minimum scale (representative fraction) at which the layer will display.

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

void setMinimumScale(double minScale)
                     throws java.io.IOException,
                            AutomationException

Minimum scale (representative fraction) at which the layer will display.

Parameters:

minScale - The minScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

double getMaximumScale()
                       throws java.io.IOException,
                              AutomationException

Maximum scale (representative fraction) at which the layer will display.

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

void setMaximumScale(double maxScale)
                     throws java.io.IOException,
                            AutomationException

Maximum scale (representative fraction) at which the layer will display.

Parameters:

maxScale - The maxScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if the layer is currently visible.

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the layer is currently visible.

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowTips

boolean isShowTips()
                   throws java.io.IOException,
                          AutomationException

Indicates if the layer shows map tips.

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowTips

void setShowTips(boolean show)
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer shows map tips.

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTipText

java.lang.String getTipText(double x,
                            double y,
                            double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Map tip text at the specified location.

Parameters:

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCached

boolean isCached()
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer needs its own display cache.

Returns:

The cached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCached

void setCached(boolean cached)
               throws java.io.IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Parameters:

cached - The cached (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

int getSupportedDrawPhases()
                           throws java.io.IOException,
                                  AutomationException

Supported draw phases.

Returns:

The drawPhases

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.IOException,
                                     AutomationException

Spatial reference for the layer.

Parameters:

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

draw

void draw(int drawPhase,
          IDisplay display,
          ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the layer to the specified display for the given draw phase.

Parameters:

drawPhase - 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)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalReference

ITemporalReference getTemporalReference()
                                        throws java.io.IOException,
                                               AutomationException

Defines the reference in time used to draw, identify, or perform other layer-based activities.

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporalReferenceByRef

void setTemporalReferenceByRef(ITemporalReference ppiTemporalReference)
                               throws java.io.IOException,
                                      AutomationException

Defines the reference in time used to draw, identify, or perform other layer-based activities.

Parameters:

ppiTemporalReference - A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalLegendGroup

ITemporalLegendGroup getTemporalLegendGroup()
                                            throws java.io.IOException,
                                                   AutomationException

Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporalLegendGroupByRef

void setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup)
                                 throws java.io.IOException,
                                        AutomationException

Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.

Parameters:

ppiTemporalLegendGroup - A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCacheFeatures

void setCacheFeatures(boolean pbAreFeaturesCached)
                      throws java.io.IOException,
                             AutomationException

Controls whether Features are cached in the renderer's feature memory or are read from the feature class.

Parameters:

pbAreFeaturesCached - The pbAreFeaturesCached (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCacheFeatures

boolean isCacheFeatures()
                        throws java.io.IOException,
                               AutomationException

Controls whether Features are cached in the renderer's feature memory or are read from the feature class.

Returns:

The pbAreFeaturesCached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureCacheWindow

int getFeatureCacheWindow()
                          throws java.io.IOException,
                                 AutomationException

Determines the number of features to cache if the CacheFeatures property is true.

Returns:

The pnPercent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureCacheWindow

void setFeatureCacheWindow(int pnPercent)
                           throws java.io.IOException,
                                  AutomationException

Determines the number of features to cache if the CacheFeatures property is true.

Parameters:

pnPercent - The pnPercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRendererByRef

void setRendererByRef(IFeatureRenderer renderer)
                      throws java.io.IOException,
                             AutomationException

Controls the temporal renderer for the layer.

Parameters:

renderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderer

IFeatureRenderer getRenderer()
                             throws java.io.IOException,
                                    AutomationException

Controls the temporal renderer for the layer.

Returns:

A reference to a com.esri.arcgis.carto.IFeatureRenderer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalFieldName

java.lang.String getTemporalFieldName()
                                      throws java.io.IOException,
                                             AutomationException

Identifies the temporal field, which must be a field type with data that can be converted to a date value.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayOnlyLastKnownEvent

boolean isDisplayOnlyLastKnownEvent()
                                    throws java.io.IOException,
                                           AutomationException

Indicates whether to display only the last known temporal event or all events in a layer.

Returns:

The pbvarLastKnownEvent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayOnlyLastKnownEvent

void setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent)
                                  throws java.io.IOException,
                                         AutomationException

Indicates whether to display only the last known temporal event or all events in a layer.

Parameters:

pbvarLastKnownEvent - The pbvarLastKnownEvent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayFutureEvents

boolean isDisplayFutureEvents()
                              throws java.io.IOException,
                                     AutomationException

Indicates whether or not to display future events for a real-time data layer.

Returns:

The pbvarFutureEvents

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayFutureEvents

void setDisplayFutureEvents(boolean pbvarFutureEvents)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether or not to display future events for a real-time data layer.

Parameters:

pbvarFutureEvents - The pbvarFutureEvents (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActionCollection

IActionCollection getActionCollection()
                                      throws java.io.IOException,
                                             AutomationException

The collection of action objects for this temporal layer.

Returns:

A reference to a com.esri.arcgis.carto.IActionCollection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActionCollectionByRef

void setActionCollectionByRef(IActionCollection pVal)
                              throws java.io.IOException,
                                     AutomationException

The collection of action objects for this temporal layer.

Parameters:

pVal - A reference to a com.esri.arcgis.carto.IActionCollection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

processActions

void processActions(boolean bvarResetActions)
                    throws java.io.IOException,
                           AutomationException

Apply the actions, contained in the action collection, to this temporal layer.

Parameters:

bvarResetActions - The bvarResetActions (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelativeTimeColor

int getRelativeTimeColor()
                         throws java.io.IOException,
                                AutomationException

Indicates a relative color differential based on temporal class characteristics.

Returns:

The pVal (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativeTimeColor

void setRelativeTimeColor(int pVal)
                          throws java.io.IOException,
                                 AutomationException

Indicates a relative color differential based on temporal class characteristics.

Parameters:

pVal - The pVal (A COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelativeTimeOperator

ITemporalOperator getRelativeTimeOperator()
                                          throws java.io.IOException,
                                                 AutomationException

The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativeTimeOperator

void setRelativeTimeOperator(ITemporalOperator pVal)
                             throws java.io.IOException,
                                    AutomationException

The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.

Parameters:

pVal - A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTemporalExtent

void queryTemporalExtent(java.lang.Object[] pvarStartTime,
                         java.lang.Object[] pvarEndTime)
                         throws java.io.IOException,
                                AutomationException

Obtain the start and end temporal values of the temporal layer's features.

Parameters:

pvarStartTime - A Variant (in/out: use single element array)

pvarEndTime - A Variant (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEventIDFieldName

java.lang.String getEventIDFieldName()
                                     throws java.io.IOException,
                                            AutomationException

Indicates the field containing the EventID information for the data.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

suspendIndexing

void suspendIndexing(boolean bvarSuspend)
                     throws java.io.IOException,
                            AutomationException

This method suspends or resumes indexing on a temporal layer.

Parameters:

bvarSuspend - The bvarSuspend (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.