|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.interop.Dispatch com.esri.arcgis.trackinganalyst.ITemporalLayerProxy
public class ITemporalLayerProxy
Provides access to properties and methods needed to manage temporal layer functionality.
The temporal layer interface controls property content that enables a layer to be rendered or exploited temporally. This interface provides properties and methods to control how the events are displayed (e.g. displaying future events, last known events), whether and how to cache features, and temporal and spatial attributes. This interface also provides property and methods to access action collection and process actions.
Field Summary | |
---|---|
boolean |
noncastable
|
Fields inherited from class com.esri.arcgis.interop.Dispatch |
---|
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef |
Constructor Summary | |
---|---|
|
ITemporalLayerProxy()
|
|
ITemporalLayerProxy(Object obj)
|
protected |
ITemporalLayerProxy(Object obj,
String iid)
|
Method Summary | |
---|---|
void |
addListener(String iidStr,
Object theListener,
Object theSource)
|
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. |
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. |
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. |
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. |
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(Object[] pvarStartTime,
Object[] pvarEndTime)
Obtain the start and end temporal values of the temporal layer's features. |
void |
removeListener(String iidStr,
Object theListener)
|
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(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. |
Methods inherited from class com.esri.arcgis.interop.Dispatch |
---|
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public boolean noncastable
Constructor Detail |
---|
public ITemporalLayerProxy()
public ITemporalLayerProxy(Object obj) throws IOException
IOException
protected ITemporalLayerProxy(Object obj, String iid) throws IOException
IOException
Method Detail |
---|
public void addListener(String iidStr, Object theListener, Object theSource) throws IOException
addListener
in class com.esri.arcgis.interop.Dispatch
IOException
public void removeListener(String iidStr, Object theListener) throws IOException
removeListener
in class com.esri.arcgis.interop.Dispatch
IOException
public String getName() throws IOException, AutomationException
getName
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface ITemporalLayer
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isValid() throws IOException, AutomationException
isValid
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getAreaOfInterest() throws IOException, AutomationException
getAreaOfInterest
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMinimumScale() throws IOException, AutomationException
getMinimumScale
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinimumScale(double minScale) throws IOException, AutomationException
setMinimumScale
in interface ITemporalLayer
minScale
- The minScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMaximumScale() throws IOException, AutomationException
getMaximumScale
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaximumScale(double maxScale) throws IOException, AutomationException
setMaximumScale
in interface ITemporalLayer
maxScale
- The maxScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVisible() throws IOException, AutomationException
isVisible
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVisible(boolean visible) throws IOException, AutomationException
setVisible
in interface ITemporalLayer
visible
- The visible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowTips() throws IOException, AutomationException
isShowTips
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowTips(boolean show) throws IOException, AutomationException
setShowTips
in interface ITemporalLayer
show
- The show (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTipText(double x, double y, double tolerance) throws IOException, AutomationException
getTipText
in interface ITemporalLayer
x
- The x (in)y
- The y (in)tolerance
- The tolerance (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCached() throws IOException, AutomationException
Temporal layers are always cached. Therefore this property is not re-configurable.
isCached
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCached(boolean cached) throws IOException, AutomationException
setCached
in interface ITemporalLayer
cached
- The cached (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSupportedDrawPhases() throws IOException, AutomationException
getSupportedDrawPhases
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSpatialReferenceByRef(ISpatialReference rhs1) throws IOException, AutomationException
setSpatialReferenceByRef
in interface ITemporalLayer
rhs1
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) throws IOException, AutomationException
draw
in interface ITemporalLayer
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITemporalReference getTemporalReference() throws IOException, AutomationException
The Temporal Reference Property is a Temporal Reference Object that defines the reference in time that is used to draw, identify, or perform other layer activities on this layer.
getTemporalReference
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTemporalReferenceByRef(ITemporalReference ppiTemporalReference) throws IOException, AutomationException
The Temporal Reference Property is a Temporal Reference Object that defines the reference in time that is used to draw, identify, or perform other layer activities on this layer.
setTemporalReferenceByRef
in interface ITemporalLayer
ppiTemporalReference
- A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITemporalLegendGroup getTemporalLegendGroup() throws IOException, AutomationException
This property is a group of temporal legend classes that define the temporal intervals and symbology that the temporal renderer uses. This legend group collectively defines the temporal period that is used to draw features.
getTemporalLegendGroup
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup) throws IOException, AutomationException
This property is a group of temporal legend classes that define the temporal intervals and symbology that the temporal renderer uses. This legend group collectively defines the temporal period that is used to draw features.
setTemporalLegendGroupByRef
in interface ITemporalLayer
ppiTemporalLegendGroup
- A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCacheFeatures(boolean pbAreFeaturesCached) throws IOException, AutomationException
This property controls whether features are cached in the renderer's feature memory or are read from the feature class.
setCacheFeatures
in interface ITemporalLayer
pbAreFeaturesCached
- The pbAreFeaturesCached (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCacheFeatures() throws IOException, AutomationException
This property controls whether features are cached in the renderer's feature memory or are read from the feature class.
isCacheFeatures
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getFeatureCacheWindow() throws IOException, AutomationException
Reserved for future use.
getFeatureCacheWindow
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFeatureCacheWindow(int pnPercent) throws IOException, AutomationException
Reserved for future use
setFeatureCacheWindow
in interface ITemporalLayer
pnPercent
- The pnPercent (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRendererByRef(IFeatureRenderer renderer) throws IOException, AutomationException
setRendererByRef
in interface ITemporalLayer
renderer
- A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureRenderer getRenderer() throws IOException, AutomationException
getRenderer
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTemporalFieldName() throws IOException, AutomationException
getTemporalFieldName
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDisplayOnlyLastKnownEvent() throws IOException, AutomationException
isDisplayOnlyLastKnownEvent
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent) throws IOException, AutomationException
setDisplayOnlyLastKnownEvent
in interface ITemporalLayer
pbvarLastKnownEvent
- The pbvarLastKnownEvent (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDisplayFutureEvents() throws IOException, AutomationException
isDisplayFutureEvents
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDisplayFutureEvents(boolean pbvarFutureEvents) throws IOException, AutomationException
setDisplayFutureEvents
in interface ITemporalLayer
pbvarFutureEvents
- The pbvarFutureEvents (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IActionCollection getActionCollection() throws IOException, AutomationException
getActionCollection
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setActionCollectionByRef(IActionCollection pVal) throws IOException, AutomationException
setActionCollectionByRef
in interface ITemporalLayer
pVal
- A reference to a com.esri.arcgis.carto.IActionCollection (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void processActions(boolean bvarResetActions) throws IOException, AutomationException
If bvarResetActions is true, actions collection will be reset to the default state.
processActions
in interface ITemporalLayer
bvarResetActions
- The bvarResetActions (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getRelativeTimeColor() throws IOException, AutomationException
getRelativeTimeColor
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRelativeTimeColor(int pVal) throws IOException, AutomationException
setRelativeTimeColor
in interface ITemporalLayer
pVal
- The pVal (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITemporalOperator getRelativeTimeOperator() throws IOException, AutomationException
This property indicates the relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer. The temporal offset can be an interval.
getRelativeTimeOperator
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRelativeTimeOperator(ITemporalOperator pVal) throws IOException, AutomationException
setRelativeTimeOperator
in interface ITemporalLayer
pVal
- A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime) throws IOException, AutomationException
queryTemporalExtent
in interface ITemporalLayer
pvarStartTime
- A Variant (in/out: use single element array)pvarEndTime
- A Variant (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getEventIDFieldName() throws IOException, AutomationException
getEventIDFieldName
in interface ITemporalLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void suspendIndexing(boolean bvarSuspend) throws IOException, AutomationException
suspendIndexing
in interface ITemporalLayer
bvarSuspend
- The bvarSuspend (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |