com.esri.arcgis.trackinganalyst
Class TemporalLegendClass

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TemporalLegendClass
All Implemented Interfaces:
ILegendClass, com.esri.arcgis.interop.RemoteObjRef, IClone, ITemporalLegendClass, Serializable

public class TemporalLegendClass
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalLegendClass, ILegendClass, IClone

Controls settings for individual temporal class, such as time window period and offset.

Description

This Object extends the ESRI Legend Class to tailor it for temporal capabilities.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:
Serialized Form

Constructor Summary
TemporalLegendClass()
          Constructs a TemporalLegendClass using ArcGIS Engine.
TemporalLegendClass(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalLegendClass theTemporalLegendClass = (TemporalLegendClass) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
static String getClsid()
          getClsid.
 String getDescription()
          Legend class description.
 ILegendClassFormat getFormat()
          Optional.
 String getLabel()
          Legend class label.
 double getPeriod()
          Indicates period setting for temporal data layer.
 double getStartingOffset()
          Indicates initial offset setting for temporal data.
 ISymbol getSymbol()
          Legend class symbol.
 IColor getSymbolColor()
          Indicates symbol size setting for temporal events as they display on the map.
 double getSymbolSize()
          Indicates symbol size setting for temporal events as they display on the map.
 int getTimeUnits()
          Indicates unit of time used to define period of time window.
 int getType()
          Identifies special drawing properties of a temporal legend class.
 int hashCode()
          the hashcode for this object
 boolean intersects(Object vTimeValue)
          Determines whether or not the Time Value intersects the Reference and TimeValue parameters.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void setDescription(String label)
          Legend class description.
 void setFormat(ILegendClassFormat format)
          Optional.
 void setLabel(String label)
          Legend class label.
 void setPeriod(double pVal)
          Indicates period setting for temporal data layer.
 void setReference(Object varReference)
          Sets the temporal reference properties for the temporal legend class.
 void setStartingOffset(double pVal)
          Indicates initial offset setting for temporal data.
 void setSymbolByRef(ISymbol symbol)
          Legend class symbol.
 void setTimeUnits(int pVal)
          Indicates unit of time used to define period of time window.
 void setType(int penumTemporalLegendType)
          Identifies special drawing properties of a temporal legend class.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

TemporalLegendClass

public TemporalLegendClass()
                    throws IOException,
                           UnknownHostException
Constructs a TemporalLegendClass using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TemporalLegendClass

public TemporalLegendClass(Object obj)
                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalLegendClass theTemporalLegendClass = (TemporalLegendClass) obj;

Construct a TemporalLegendClass using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TemporalLegendClass.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getSymbol

public ISymbol getSymbol()
                  throws IOException,
                         AutomationException
Legend class symbol.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getSymbol in interface ILegendClass
Specified by:
getSymbol in interface ITemporalLegendClass
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws IOException,
                           AutomationException
Legend class symbol.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setSymbolByRef in interface ILegendClass
Specified by:
setSymbolByRef in interface ITemporalLegendClass
Parameters:
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException
Legend class label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getLabel in interface ILegendClass
Specified by:
getLabel in interface ITemporalLegendClass
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException
Legend class label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setLabel in interface ILegendClass
Specified by:
setLabel in interface ITemporalLegendClass
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
Legend class description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getDescription in interface ILegendClass
Specified by:
getDescription in interface ITemporalLegendClass
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String label)
                    throws IOException,
                           AutomationException
Legend class description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setDescription in interface ILegendClass
Specified by:
setDescription in interface ITemporalLegendClass
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFormat

public ILegendClassFormat getFormat()
                             throws IOException,
                                    AutomationException
Optional. If non-null, then layer specifies class formatting information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getFormat in interface ILegendClass
Specified by:
getFormat in interface ITemporalLegendClass
Returns:
A reference to a com.esri.arcgis.carto.ILegendClassFormat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFormat

public void setFormat(ILegendClassFormat format)
               throws IOException,
                      AutomationException
Optional. If non-null, then layer specifies class formatting information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setFormat in interface ILegendClass
Specified by:
setFormat in interface ITemporalLegendClass
Parameters:
format - A reference to a com.esri.arcgis.carto.ILegendClassFormat (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStartingOffset

public double getStartingOffset()
                         throws IOException,
                                AutomationException
Indicates initial offset setting for temporal data.

Description

The starting offset property is used to determine the period of time from the current temporal perspective that the range is to be evaluated for.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getStartingOffset in interface ITemporalLegendClass
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartingOffset

public void setStartingOffset(double pVal)
                       throws IOException,
                              AutomationException
Indicates initial offset setting for temporal data.

Description

The starting offset property is used to determine the period of time from the current temporal perspective that the range is to be evaluated for.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setStartingOffset in interface ITemporalLegendClass
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPeriod

public double getPeriod()
                 throws IOException,
                        AutomationException
Indicates period setting for temporal data layer.

Description

The period property is the amount of history or period of time from the Starting offset that the period is to be evaluated for.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getPeriod in interface ITemporalLegendClass
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPeriod

public void setPeriod(double pVal)
               throws IOException,
                      AutomationException
Indicates period setting for temporal data layer.

Description

The period property is the amount of history or period of time from the Starting offset that the period is to be evaluated for.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setPeriod in interface ITemporalLegendClass
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeUnits

public int getTimeUnits()
                 throws IOException,
                        AutomationException
Indicates unit of time used to define period of time window.

Description

The time units property defines the time units that the Starting Offset and period property values use.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTimeUnits in interface ITemporalLegendClass
Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeUnits

public void setTimeUnits(int pVal)
                  throws IOException,
                         AutomationException
Indicates unit of time used to define period of time window.

Description

The time units property defines the time units that the Starting Offset and period property values use.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTimeUnits in interface ITemporalLegendClass
Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException
Identifies special drawing properties of a temporal legend class.

Description

The Type is used to identify special drawing properties of a temporal legend class. The valid values are as follows:

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getType in interface ITemporalLegendClass
Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalLegendType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int penumTemporalLegendType)
             throws IOException,
                    AutomationException
Identifies special drawing properties of a temporal legend class.

Description

The Type is used to identify special drawing properties of a temporal legend class. The valid values are as follows:

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setType in interface ITemporalLegendClass
Parameters:
penumTemporalLegendType - A com.esri.arcgis.trackinganalyst.enumTemporalLegendType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

intersects

public boolean intersects(Object vTimeValue)
                   throws IOException,
                          AutomationException
Determines whether or not the Time Value intersects the Reference and TimeValue parameters.

Description

The intersects method takes two parameters--
* Reference
* TimeValue
and determines whether or not the Time Value intersects this range.

The Reference and TimeValue arguments use the CTimeStamp Variant format which is a array of 3 long integers. See the CTimeStamp documentation for further details.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
intersects in interface ITemporalLegendClass
Parameters:
vTimeValue - A Variant (in)
Returns:
The pbInersects
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReference

public void setReference(Object varReference)
                  throws IOException,
                         AutomationException
Sets the temporal reference properties for the temporal legend class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setReference in interface ITemporalLegendClass
Parameters:
varReference - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbolSize

public double getSymbolSize()
                     throws IOException,
                            AutomationException
Indicates symbol size setting for temporal events as they display on the map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getSymbolSize in interface ITemporalLegendClass
Returns:
The pdSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbolColor

public IColor getSymbolColor()
                      throws IOException,
                             AutomationException
Indicates symbol size setting for temporal events as they display on the map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getSymbolColor in interface ITemporalLegendClass
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.