com.esri.arcgis.trackinganalyst
Interface ITemporalRenderer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CoTrackSymbologyRenderer, ITemporalRendererProxy

public interface ITemporalRenderer
extends java.io.Serializable

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

Description: 'Provides access to methods and properties needed to apply symbology with temporal color as well as standard Esri symbology.' 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	IID7fbcb640_1712_11d5_b7cf_00010265adc5
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	canRender(IFeatureClass featClass, IDisplay display) Indicates if the specified feature class can be rendered on the given display.
void	canRenderComponent(IFeatureClass piFeatClass, IDisplay piDisplay, boolean[] pbvarResult, java.lang.Object piComponent, java.lang.String bstrComponent) Uses the renderer from component tree in symbology dialog to determine if this renderer can be used with this component.
void	draw(IFeatureCursor cursor, int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws features from the specified cursor on the given display.
IPropertySet	getComponentSets() Used to contain the properties of all of the various temporal renderers.
IFeatureRenderer	getObservationRenderer() Renders observation symbology using functionality of standard Esri symbology system.
ISymbol	getSymbolByFeature(IFeature feature) Symbol used to draw the specified feature.
java.lang.String	getTemporalFieldName() Identifies the temporal field, which must be a field type whoe data can be converted to a date value.
ITemporalLegendGroup	getTemporalLegend() Points to a Temporal Legend class that defines how symbology is rendered temporally.
java.lang.String	getTemporalObjectColumnName() Indicates the feature class column that identifies or groups temporal observations with time series.
java.lang.Object	getTemporalPerspective() A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.
int	getTimeSymbologyMethod() Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.
boolean	isDisplayFutureEvents() Indicates whether or not future events are drawn on the map in real-time mode.
boolean	isRenderPhase(int drawPhase) Indicates if renderer uses the specified draw phase.
boolean	isShowObservationLegendGroup() Controls whether or not the observation legend is drawn in the table of contents.
boolean	isShowTimeLegendGroup() Controls access to the time legend group.
void	prepareFilter(IFeatureClass fc, IQueryFilter queryFilter) Prepares the query filter for the rendering process.
void	setComponentSets(IPropertySet pVal) Used to contain the properties of all of the various temporal renderers.
void	setDisplayFutureEvents(boolean pVal) Indicates whether or not future events are drawn on the map in real-time mode.
void	setExclusionSetByRef(IFeatureIDSet rhs1) An object reference to a temporary drawing exclusion set.
void	setFromPropertyPages(boolean rhs1) Indicates who is making the request for the legend: the property pages.
void	setMostCurrentFIDs(IFeatureIDSet piFIDSet) Method SetMostCurrentFIDs.
void	setObservationRendererByRef(IFeatureRenderer ppiRenderer) Renders observation symbology using functionality of standard Esri symbology system.
void	setShowObservationLegendGroup(boolean pbShowObservations) Controls whether or not the observation legend is drawn in the table of contents.
void	setShowTimeLegendGroup(boolean pbShowTimeLegends) Controls access to the time legend group.
void	setTemporalFieldName(java.lang.String pbstrTemporalFieldName) Identifies the temporal field, which must be a field type whoe data can be converted to a date value.
void	setTemporalLegendByRef(ITemporalLegendGroup ppiTemporalLegend) Points to a Temporal Legend class that defines how symbology is rendered temporally.
void	setTemporalObjectColumnName(java.lang.String pVal) Indicates the feature class column that identifies or groups temporal observations with time series.
void	setTemporalPerspective(java.lang.Object pVal) A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.
void	setTimeSymbologyMethod(int penumSymbolizationMethod) Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.

Field Detail

IID7fbcb640_1712_11d5_b7cf_00010265adc5

static final int IID7fbcb640_1712_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

canRender

boolean canRender(IFeatureClass featClass,
                  IDisplay display)
                  throws java.io.IOException,
                         AutomationException

Indicates if the specified feature class can be rendered on the given display.

Parameters:

featClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

display - A reference to a com.esri.arcgis.display.IDisplay (in)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareFilter

void prepareFilter(IFeatureClass fc,
                   IQueryFilter queryFilter)
                   throws java.io.IOException,
                          AutomationException

Prepares the query filter for the rendering process.

Parameters:

fc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

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

Draws features from the specified cursor on the given display.

Parameters:

cursor - A reference to a com.esri.arcgis.geodatabase.IFeatureCursor (in)

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.

getSymbolByFeature

ISymbol getSymbolByFeature(IFeature feature)
                           throws java.io.IOException,
                                  AutomationException

Symbol used to draw the specified feature.

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRenderPhase

boolean isRenderPhase(int drawPhase)
                      throws java.io.IOException,
                             AutomationException

Indicates if renderer uses the specified draw phase.

Parameters:

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExclusionSetByRef

void setExclusionSetByRef(IFeatureIDSet rhs1)
                          throws java.io.IOException,
                                 AutomationException

An object reference to a temporary drawing exclusion set.

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObservationRenderer

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

Renders observation symbology using functionality of standard Esri symbology system.

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.

setObservationRendererByRef

void setObservationRendererByRef(IFeatureRenderer ppiRenderer)
                                 throws java.io.IOException,
                                        AutomationException

Renders observation symbology using functionality of standard Esri symbology system.

Parameters:

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

getTemporalFieldName

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

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

Returns:

The pbstrTemporalFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporalFieldName

void setTemporalFieldName(java.lang.String pbstrTemporalFieldName)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

pbstrTemporalFieldName - The pbstrTemporalFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowObservationLegendGroup

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

Controls whether or not the observation legend is drawn in the table of contents.

Returns:

The pbShowObservations

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowObservationLegendGroup

void setShowObservationLegendGroup(boolean pbShowObservations)
                                   throws java.io.IOException,
                                          AutomationException

Controls whether or not the observation legend is drawn in the table of contents.

Parameters:

pbShowObservations - The pbShowObservations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowTimeLegendGroup

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

Controls access to the time legend group.

Returns:

The pbShowTimeLegends

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowTimeLegendGroup

void setShowTimeLegendGroup(boolean pbShowTimeLegends)
                            throws java.io.IOException,
                                   AutomationException

Controls access to the time legend group.

Parameters:

pbShowTimeLegends - The pbShowTimeLegends (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalLegend

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

Points to a Temporal Legend class that defines how symbology is rendered temporally.

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.

setTemporalLegendByRef

void setTemporalLegendByRef(ITemporalLegendGroup ppiTemporalLegend)
                            throws java.io.IOException,
                                   AutomationException

Points to a Temporal Legend class that defines how symbology is rendered temporally.

Parameters:

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

setFromPropertyPages

void setFromPropertyPages(boolean rhs1)
                          throws java.io.IOException,
                                 AutomationException

Indicates who is making the request for the legend: the property pages.

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeSymbologyMethod

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

Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalSymbolizationMethod constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeSymbologyMethod

void setTimeSymbologyMethod(int penumSymbolizationMethod)
                            throws java.io.IOException,
                                   AutomationException

Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.

Parameters:

penumSymbolizationMethod - A com.esri.arcgis.trackinganalyst.enumTemporalSymbolizationMethod constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalObjectColumnName

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

Indicates the feature class column that identifies or groups temporal observations with time series.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporalObjectColumnName

void setTemporalObjectColumnName(java.lang.String pVal)
                                 throws java.io.IOException,
                                        AutomationException

Indicates the feature class column that identifies or groups temporal observations with time series.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalPerspective

java.lang.Object getTemporalPerspective()
                                        throws java.io.IOException,
                                               AutomationException

A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporalPerspective

void setTemporalPerspective(java.lang.Object pVal)
                            throws java.io.IOException,
                                   AutomationException

A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getComponentSets

IPropertySet getComponentSets()
                              throws java.io.IOException,
                                     AutomationException

Used to contain the properties of all of the various temporal renderers.

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.

setComponentSets

void setComponentSets(IPropertySet pVal)
                      throws java.io.IOException,
                             AutomationException

Used to contain the properties of all of the various temporal renderers.

Parameters:

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

canRenderComponent

void canRenderComponent(IFeatureClass piFeatClass,
                        IDisplay piDisplay,
                        boolean[] pbvarResult,
                        java.lang.Object piComponent,
                        java.lang.String bstrComponent)
                        throws java.io.IOException,
                               AutomationException

Uses the renderer from component tree in symbology dialog to determine if this renderer can be used with this component.

Parameters:

piFeatClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

piDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pbvarResult - The pbvarResult (in/out: use single element array)

piComponent - A reference to another Object (IUnknown) (in)

bstrComponent - The bstrComponent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMostCurrentFIDs

void setMostCurrentFIDs(IFeatureIDSet piFIDSet)
                        throws java.io.IOException,
                               AutomationException

Method SetMostCurrentFIDs.

Parameters:

piFIDSet - A reference to a com.esri.arcgis.carto.IFeatureIDSet (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 future events are drawn on the map in real-time mode.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayFutureEvents

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

Indicates whether or not future events are drawn on the map in real-time mode.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.