com.esri.arcgis.trackinganalyst
Class EventAttributeProperties

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.EventAttributeProperties
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IEventAttributeProperties, java.io.Externalizable, java.io.Serializable

public class EventAttributeProperties
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IEventAttributeProperties, IClone, IPersist, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'A holding component for event attribute properties.' 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.IEventAttributeProperties
IID, IID9bfdbad9_2064_4f45_b952_996fd9b029fa, 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
 
Constructor Summary
EventAttributeProperties()
          Constructs a EventAttributeProperties using ArcGIS Engine.
EventAttributeProperties(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EventAttributeProperties theEventAttributeProperties = (EventAttributeProperties) 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.
 ITextElement createTextElement()
          Creates a new text element generated from the ITextSymbol property.
 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.
 IStringArray getFieldNames()
          The eventís field names whose values will be used generate text when rendering.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getNumFields()
          The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ITextSymbol getTextSymbol()
          The text symbol for rendering an eventís selective set of attributes.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isGlobalProperties()
          Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs.
 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 EventAttributeProperties.
 void save(IStream pstm, int fClearDirty)
          save
 void setFieldNamesByRef(IStringArray pVal)
          The eventís field names whose values will be used generate text when rendering.
 void setGlobalProperties(boolean pVal)
          Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs.
 void setNumFields(int pVal)
          The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.
 void setTextSymbolByRef(ITextSymbol pVal)
          The text symbol for rendering an eventís selective set of attributes.
 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

EventAttributeProperties

public EventAttributeProperties()
                         throws java.io.IOException,
                                java.net.UnknownHostException
Constructs a EventAttributeProperties using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

EventAttributeProperties

public EventAttributeProperties(java.lang.Object obj)
                         throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EventAttributeProperties theEventAttributeProperties = (EventAttributeProperties) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws java.io.IOException,
                                 AutomationException
The text symbol for rendering an eventís selective set of attributes.

Specified by:
getTextSymbol in interface IEventAttributeProperties
Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

public void setTextSymbolByRef(ITextSymbol pVal)
                        throws java.io.IOException,
                               AutomationException
The text symbol for rendering an eventís selective set of attributes.

Specified by:
setTextSymbolByRef in interface IEventAttributeProperties
Parameters:
pVal - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldNames

public IStringArray getFieldNames()
                           throws java.io.IOException,
                                  AutomationException
The eventís field names whose values will be used generate text when rendering.

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

setFieldNamesByRef

public void setFieldNamesByRef(IStringArray pVal)
                        throws java.io.IOException,
                               AutomationException
The eventís field names whose values will be used generate text when rendering.

Specified by:
setFieldNamesByRef in interface IEventAttributeProperties
Parameters:
pVal - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumFields

public int getNumFields()
                 throws java.io.IOException,
                        AutomationException
The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.

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

setNumFields

public void setNumFields(int pVal)
                  throws java.io.IOException,
                         AutomationException
The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.

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

createTextElement

public ITextElement createTextElement()
                               throws java.io.IOException,
                                      AutomationException
Creates a new text element generated from the ITextSymbol property.

Specified by:
createTextElement in interface IEventAttributeProperties
Returns:
A reference to a com.esri.arcgis.carto.ITextElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGlobalProperties

public boolean isGlobalProperties()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

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

setGlobalProperties

public void setGlobalProperties(boolean pVal)
                         throws java.io.IOException,
                                AutomationException
Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

Specified by:
setGlobalProperties in interface IEventAttributeProperties
Parameters:
pVal - The pVal (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.

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.

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.

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.

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