com.esri.arcgis.trackinganalyst
Class TemporalLegendClass

java.lang.Object
  com.esri.arcgis.trackinganalyst.TemporalLegendClass

All Implemented Interfaces:

IDynamicLegendClass, ILegendClass, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, ITemporalLegendClass, ITemporalLegendClass2, java.io.Externalizable, java.io.Serializable

public class TemporalLegendClass
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalLegendClass, ITemporalLegendClass2, ILegendClass, IClone, IPersistStream, IPersist, ISupportErrorInfo, IDocumentVersionSupportGEN, IDynamicLegendClass, java.io.Externalizable

COM Class 'TemporalLegendClass'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Controls settings for individual temporal class, such as time window period and offset.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITemporalLegendClass2

IID, IID9a974de5_dd87_43cb_928e_eae5c62f83ad, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITemporalLegendClass

IIDb75d6fb8_1333_11d5_b7c9_00010265adc5

Fields inherited from interface com.esri.arcgis.carto.ILegendClass

IID, IID167c5e9e_af20_11d1_8817_080009ec732a, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDynamicLegendClass

IID, IID19479dcb_5ec5_4f51_82ac_8083ee14ba23, xxDummy

Constructor Summary

TemporalLegendClass()
Constructs a TemporalLegendClass using ArcGIS Engine.

TemporalLegendClass(java.lang.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.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getCount() Count of the times the legend class appears in the visible map extent.
java.lang.String	getDescription() Legend class description.
ILegendClassFormat	getFormat() Optional.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLabel() Legend class label.
double	getPeriod() Indicates period setting for temporal data layer.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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	getTemporalSymbolizationMethod() The symbol attributes that will be changed.
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
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	intersects(java.lang.Object vTimeValue) Determines whether or not the Time Value intersects the Reference and TimeValue parameters.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a TemporalLegendClass.
void	save(IStream pstm, int fClearDirty) save
void	setCount(int count) Count of the times the legend class appears in the visible map extent.
void	setDescription(java.lang.String label) Legend class description.
void	setFormat(ILegendClassFormat format) Optional.
void	setLabel(java.lang.String label) Legend class label.
void	setPeriod(double pVal) Indicates period setting for temporal data layer.
void	setReference(java.lang.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	setTemporalSymbolizationMethod(int temporalSymbolizationMethod) The symbol attributes that will be changed.
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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

TemporalLegendClass

public TemporalLegendClass()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a TemporalLegendClass using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TemporalLegendClass

public TemporalLegendClass(java.lang.Object obj)
                    throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a TemporalLegendClass.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getSymbol

public ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException

Legend class symbol.

Specified by:

getSymbol in interface ILegendClass

Specified by:

getSymbol in interface ITemporalLegendClass

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.

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Legend class symbol.

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:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

public java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException

Legend class label.

Specified by:

getLabel in interface ILegendClass

Specified by:

getLabel in interface ITemporalLegendClass

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(java.lang.String label)
              throws java.io.IOException,
                     AutomationException

Legend class label.

Specified by:

setLabel in interface ILegendClass

Specified by:

setLabel in interface ITemporalLegendClass

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Legend class description.

Specified by:

getDescription in interface ILegendClass

Specified by:

getDescription in interface ITemporalLegendClass

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String label)
                    throws java.io.IOException,
                           AutomationException

Legend class description.

Specified by:

setDescription in interface ILegendClass

Specified by:

setDescription in interface ITemporalLegendClass

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormat

public ILegendClassFormat getFormat()
                             throws java.io.IOException,
                                    AutomationException

Optional. If non-null, then layer specifies class formatting information.

Specified by:

getFormat in interface ILegendClass

Specified by:

getFormat in interface ITemporalLegendClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormat

public void setFormat(ILegendClassFormat format)
               throws java.io.IOException,
                      AutomationException

Optional. If non-null, then layer specifies class formatting information.

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:

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

AutomationException - If the ArcObject component throws an exception.

getStartingOffset

public double getStartingOffset()
                         throws java.io.IOException,
                                AutomationException

Indicates initial offset setting for temporal data.

Specified by:

getStartingOffset in interface ITemporalLegendClass

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartingOffset

public void setStartingOffset(double pVal)
                       throws java.io.IOException,
                              AutomationException

Indicates initial offset setting for temporal data.

Specified by:

setStartingOffset in interface ITemporalLegendClass

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPeriod

public double getPeriod()
                 throws java.io.IOException,
                        AutomationException

Indicates period setting for temporal data layer.

Specified by:

getPeriod in interface ITemporalLegendClass

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPeriod

public void setPeriod(double pVal)
               throws java.io.IOException,
                      AutomationException

Indicates period setting for temporal data layer.

Specified by:

setPeriod in interface ITemporalLegendClass

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeUnits

public int getTimeUnits()
                 throws java.io.IOException,
                        AutomationException

Indicates unit of time used to define period of time window.

Specified by:

getTimeUnits in interface ITemporalLegendClass

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeUnits

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

Indicates unit of time used to define period of time window.

Specified by:

setTimeUnits in interface ITemporalLegendClass

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

Identifies special drawing properties of a temporal legend class.

Specified by:

getType in interface ITemporalLegendClass

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalLegendType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int penumTemporalLegendType)
             throws java.io.IOException,
                    AutomationException

Identifies special drawing properties of a temporal legend class.

Specified by:

setType in interface ITemporalLegendClass

Parameters:

penumTemporalLegendType - A com.esri.arcgis.trackinganalyst.enumTemporalLegendType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

intersects

public boolean intersects(java.lang.Object vTimeValue)
                   throws java.io.IOException,
                          AutomationException

Determines whether or not the Time Value intersects the Reference and TimeValue parameters.

Specified by:

intersects in interface ITemporalLegendClass

Parameters:

vTimeValue - A Variant (in)

Returns:

The pbInersects

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReference

public void setReference(java.lang.Object varReference)
                  throws java.io.IOException,
                         AutomationException

Sets the temporal reference properties for the temporal legend class.

Specified by:

setReference in interface ITemporalLegendClass

Parameters:

varReference - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolSize

public double getSymbolSize()
                     throws java.io.IOException,
                            AutomationException

Indicates symbol size setting for temporal events as they display on the map.

Specified by:

getSymbolSize in interface ITemporalLegendClass

Returns:

The pdSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolColor

public IColor getSymbolColor()
                      throws java.io.IOException,
                             AutomationException

Indicates symbol size setting for temporal events as they display on the map.

Specified by:

getSymbolColor in interface ITemporalLegendClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalSymbolizationMethod

public int getTemporalSymbolizationMethod()
                                   throws java.io.IOException,
                                          AutomationException

The symbol attributes that will be changed.

Specified by:

getTemporalSymbolizationMethod in interface ITemporalLegendClass2

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.

setTemporalSymbolizationMethod

public void setTemporalSymbolizationMethod(int temporalSymbolizationMethod)
                                    throws java.io.IOException,
                                           AutomationException

The symbol attributes that will be changed.

Specified by:

setTemporalSymbolizationMethod in interface ITemporalLegendClass2

Parameters:

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

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException

Count of the times the legend class appears in the visible map extent. Initialized using IDynamicLegendLayer.

Specified by:

getCount in interface IDynamicLegendClass

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCount

public void setCount(int count)
              throws java.io.IOException,
                     AutomationException

Count of the times the legend class appears in the visible map extent. Initialized using IDynamicLegendLayer.

Specified by:

setCount in interface IDynamicLegendClass

Parameters:

count - The count (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException