com.esri.arcgis.carto.StandaloneTable
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class StandaloneTable
A standalone table.
A StandaloneTable stores data that can be added to ArcMap and used in conjuction with the layers on your map. This data doesn't display on your map, but is listed in the table of contents on the Source tab. You can work with the data in a StandaloneTable as you would work with the tablular information of geographic features. For example, you can view the table, add new fields, create graphs, and join it to other tables.
To access a StandaloneTable from your map use IStandaloneTableCollection. To access a StandaloneTable from a TableWindow, use ITableWindow2::StandaloneTable.
| Constructor Summary | |
|---|---|
StandaloneTable()
Constructs a StandaloneTable using ArcGIS Engine. |
|
StandaloneTable(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. StandaloneTable theStandaloneTable = (StandaloneTable) obj; |
|
| Method Summary | |
|---|---|
void |
addField(IField field)
Adds a field to this object class. |
void |
addIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)
addIDefinitionExpressionEventsListener. |
void |
addIndex(IIndex index)
Adds an index to this object class. |
void |
addISelectionEventsListener(ISelectionEvents theListener)
addISelectionEventsListener. |
void |
addRelationshipClass(IRelationshipClass relationshipClass)
Adds the specified memory relationship class to a standalone table or layer. |
void |
addRow(IRow row)
Adds a row to the selection set (honoring the current combination method). |
boolean |
canCopy()
True if this dataset can be copied. |
boolean |
canDelete()
True if this dataset can be deleted. |
boolean |
canRename()
True if this dataset can be renamed. |
void |
clear()
Clears the selection. |
boolean |
connect(IName pOptRepairName)
Connects the layer to its data source. |
IDataset |
copy(String copyName,
IWorkspace copyWorkspace)
Copies this dataset to a new dataset with the specified name. |
IRow |
createRow()
Creates a row in the database with a system assigned object ID and null property values. |
IRowBuffer |
createRowBuffer()
Creates a row buffer that can be used with an insert cursor. |
void |
delete()
Deletes this dataset. |
void |
deleteField(IField field)
Deletes a field from this object class. |
void |
deleteIndex(IIndex index)
Deletes an index from this object class. |
void |
deleteSearchedRows(IQueryFilter queryFilter)
Delete the Rows in the database selected by the specified query. |
void |
disconnect()
Disconnects the data from the layer. |
void |
displayRelationshipClass(IRelationshipClass relClass,
int joinType)
Sets a join based on the specified relationship class and join type. |
void |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(Object o)
Compare this object with another |
void |
findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
findConnectionPoint |
String |
findDisplayString(IObject pObject)
Finds the display string for the given feature based on the current expression properties. |
int |
findField(String fieldName)
The index of the field with the given name. |
IEnumRelationshipClass |
findRelationshipClasses(IObjectClass objectClass,
int role)
Finds all relationship classes in the collection that reference the given object class in the specified role. |
ITable |
getAttributeTable()
The attribute table. |
String |
getBrowseName()
The browse name of the dataset. |
String |
getCategory()
The category of the dataset. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
IUID |
getCLSID()
The GUID for the COM Class (CoClass) corresponding to instances of this object class. |
ITimeExtent |
getCustomTimeExtent()
Custom time extent during which a layer is visible. |
IName |
getDataSourceName()
Name of the data object for the layer. |
String |
getDefinitionExpression()
Definition query expression for the existing layer. |
ISelectionSet |
getDefinitionSelectionSet()
The selection set that defines the subset of features in a selection layer. |
String |
getDisplayField()
Primary display field. |
ISelectionSet |
getDisplaySelectionSet()
The selected set of rows from the display table. |
ITable |
getDisplayTable()
The display table. |
String |
getEndTimeFieldName()
Name of the field that has end time for a row. |
IDisplayExpressionProperties |
getExpressionProperties()
Properties that describe the display expression. |
IUID |
getEXTCLSID()
The GUID for the COM Class (CoClass) corresponding to the class extension for this object class. |
Object |
getExtension()
The extension for this object class. |
IPropertySet |
getExtensionProperties()
The extension properties for this object class. |
IField |
getField(int index)
The field at the given index. |
int |
getFieldCount()
The field count. |
IFieldInfo |
getFieldInfo(int index)
The extended field information for the field at the given index. |
IFieldInfoSet |
getFieldInfos()
The fields in order. |
IFields |
getFields()
The fields collection for this object class. |
IName |
getFullName()
The associated name object. |
ITimeExtent |
getFullTimeExtent()
Returns the time extent for all the data in the layer. |
IIndexes |
getIndexes()
The indexes collection for this object class. |
int |
getJoinType()
Join type for the most recent join performed. |
String |
getName()
Name of the standalone table. |
String |
getOIDFieldName()
The name of the field corresponding to the OID. |
IPropertySet |
getPropertySet()
The set of properties for the dataset. |
IRelationshipClass |
getRelationshipClass()
Relationship class that defines how the tables are joined. |
IEnumRelationshipClass |
getRelationshipClasses()
The memory relationship classes. |
String |
getRelativeBase()
Base path used when storing relative path names. |
IRow |
getRow(int oID)
The row from the database with the specified object ID. |
ICursor |
getRows(Object oids,
boolean recycling)
The cursor of rows based on a set of object ids. |
ISelectionSet |
getSelectionSet()
The selected set of rows. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
String |
getStartTimeFieldName()
Name of the field that has start time for a row. |
IEnumDataset |
getSubsets()
Datasets contained within this dataset. |
ITable |
getTable()
The table associated with the standalone table. |
String |
getTimeDimensionFormat()
Returns the format of the dimension that represents time. |
String |
getTimeDimensionName()
Returns the name of the dimension that represents time. |
double |
getTimeInterval()
Returns recommended time interval to be used to animate this layer/ table. |
int |
getTimeIntervalUnits()
Returns recommended time interval units to be used to animate this layer/ table. |
double |
getTimeOffset()
Returns time offset that needs to be applied to the data for drawing. |
int |
getTimeOffsetUnits()
Returns recommended time interval units to be used to animate this layer/ table. |
ITimeReference |
getTimeReference()
Time reference for the contents of the layer. |
String |
getTimeValueFormat()
Time value format if the field name is of the string format. |
String |
getTrackIDFieldName()
Field that contains the rows that uniquely identifies the object whose time is being tracked. |
int |
getType()
The type of the Dataset. |
IWorkspace |
getWorkspace()
The workspace containing this dataset. |
int |
hashCode()
the hashcode for this object |
ICursor |
insert(boolean useBuffering)
Returns a cursor that can be used to insert new Rows. |
boolean |
inWorkspace(IWorkspace workspace)
Returns TRUE if the layer is in the specified workspace. |
boolean |
isDataSourceSupported(IName name)
Indicates if the specified data object name is supported by the layer. |
void |
isDirty()
isDirty |
boolean |
isHasOID()
Indicates if the class has an object identity (OID) field. |
boolean |
isMultiDimensional()
Indicates whether the data is multi-dimensional. |
boolean |
isSupportsTime()
Indicates whether the layer has any time data. |
boolean |
isTimeDataCumulative()
Indicates that features will be animated cumilatively. |
boolean |
isUseTime()
Indicates whether to use the time for animation purposes. |
boolean |
isValid()
Indicates if the standalone table is currently valid. |
ICursor |
ITable_search(IQueryFilter queryFilter,
boolean recycling)
An object cursor that can be used to fetch row objects selected by the specified query. |
void |
load(IStream pstm)
load |
void |
onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
This event is fired when a new field is added to the object class. |
void |
onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
This event is fired when the behavior class for the object class changes. |
void |
onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
This event is fired when a field is deleted from the object class. |
void |
prepareTimeQuery(ITimeValue pTimeValue,
IQueryFilter[] pFilter)
Prepares an input query filter by appending the time expression into the where clause. |
void |
readExternal(ObjectInput in)
|
void |
removeAllRelationshipClasses()
Removes all memory relationship classes from a standalone table or layer. |
void |
removeIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)
removeIDefinitionExpressionEventsListener. |
void |
removeISelectionEventsListener(ISelectionEvents theListener)
removeISelectionEventsListener. |
void |
removeRelationshipClass(IRelationshipClass relationshipClass)
Removes the specified memory relationship class from a standalone table or layer. |
void |
rename(String name)
Renames this Dataset. |
int |
rowCount(IQueryFilter queryFilter)
The number of Rows selected by the specified query. |
void |
save(IStream pstm,
int fClearDirty)
save |
ICursor |
searchDisplayTable(IQueryFilter pQueryFilter,
boolean recycling)
Creates a cursor from the display table based upon the search criteria. |
ISelectionSet |
select(IQueryFilter queryFilter,
int selType,
int selOption,
IWorkspace selectionContainer)
A selection that contains the object ids selected by the specified query. |
ISelectionSet |
selectDisplayTable(IQueryFilter pQueryFilter,
int selType,
int selOption,
IWorkspace pSelWorkspace)
Creates a selection set from the display table based upon the search criteria. |
void |
selectionChanged()
Fires the layer update event. |
void |
selectRows(IQueryFilter filter,
int method,
boolean justOne)
Selects rows based upon the specified criteria and combination method. |
void |
setBrowseName(String name)
The browse name of the dataset. |
void |
setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime)
Custom time extent during which a layer is visible. |
void |
setDataSourceName(IName name)
Name of the data object for the layer. |
void |
setDefinitionExpression(String expression)
Definition query expression for the existing layer. |
void |
setDisplayField(String pFieldName)
Primary display field. |
void |
setEndTimeFieldName(String fieldName)
Name of the field that has end time for a row. |
void |
setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)
Properties that describe the display expression. |
void |
setFieldOrder(IFieldInfoSet fieldInfoSet)
A new order for the fields. |
void |
setName(String name)
Name of the standalone table. |
void |
setRelativeBase(String basePath)
Base path used when storing relative path names. |
void |
setSelectionSetByRef(ISelectionSet selectionSet)
The selected set of rows. |
void |
setStartTimeFieldName(String fieldName)
Name of the field that has start time for a row. |
void |
setTableByRef(ITable ppTable)
The table associated with the standalone table. |
void |
setTimeDataCumulative(boolean cumilative)
Indicates that features will be animated cumilatively. |
void |
setTimeDimensionFormat(String format)
Returns the format of the dimension that represents time. |
void |
setTimeDimensionName(String fieldName)
Returns the name of the dimension that represents time. |
void |
setTimeInterval(double interval)
Returns recommended time interval to be used to animate this layer/ table. |
void |
setTimeIntervalUnits(int units)
Returns recommended time interval units to be used to animate this layer/ table. |
void |
setTimeOffset(double timeOffset)
Returns time offset that needs to be applied to the data for drawing. |
void |
setTimeOffsetUnits(int units)
Returns recommended time interval units to be used to animate this layer/ table. |
void |
setTimeReferenceByRef(ITimeReference nativeTimeReference)
Time reference for the data. |
void |
setTimeValueFormat(String format)
Time value format if the field name is of the string format. |
void |
setTrackIDFieldName(String fieldName)
Field that contains the rows that uniquely identifies the object whose time is being tracked. |
void |
setUseTime(boolean useTime)
Indicates whether to use the time for animation purposes. |
ICursor |
update(IQueryFilter queryFilter,
boolean recycling)
Returns a cursor that can be used to update Rows selected by the specified query. |
void |
updateSearchedRows(IQueryFilter queryFilter,
IRowBuffer buffer)
Update the Rows in the database selected by the specified query. |
void |
writeExternal(ObjectOutput out)
|
| 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 |
|---|
public StandaloneTable()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public StandaloneTable(Object obj)
throws IOException
StandaloneTable theStandaloneTable = (StandaloneTable) obj;
obj to StandaloneTable.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void addISelectionEventsListener(ISelectionEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.
IOException - If there are communications problems.
public void removeISelectionEventsListener(ISelectionEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.
IOException - If there are communications problems.
public void addIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IDefinitionExpressionEvents interface.
IOException - If there are communications problems.
public void removeIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IDefinitionExpressionEvents interface.
IOException - If there are communications problems.
public String getName()
throws IOException,
AutomationException
getName in interface IStandaloneTablegetName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(String name)
throws IOException,
AutomationException
setName in interface IStandaloneTablename - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable getTable()
throws IOException,
AutomationException
getTable in interface IStandaloneTableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTableByRef(ITable ppTable)
throws IOException,
AutomationException
setTableByRef in interface IStandaloneTableppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isValid()
throws IOException,
AutomationException
isValid in interface IStandaloneTableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getDisplayField()
throws IOException,
AutomationException
getDisplayField in interface IStandaloneTableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDisplayField(String pFieldName)
throws IOException,
AutomationException
setDisplayField in interface IStandaloneTablepFieldName - The pFieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable getDisplayTable()
throws IOException,
AutomationException
getDisplayTable in interface IDisplayTableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor searchDisplayTable(IQueryFilter pQueryFilter,
boolean recycling)
throws IOException,
AutomationException
QueryFilter specifies an IQueryFilterObject to be used for the search.
Recycling specifies whether the resulting cursor is recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor.
If there is a definition query set on the layer or table, the SearchDisplayTable method will work on the subset of rows that meet the definition criteria. Otherwise, it will search the whole table.
SearchDisplayTable will return an ICursor with all of the rows that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the cursor will have all of the rows from the table.
This SearchDisplayTable method will also work on joined fields if you qualify the field names. For example, if you want to search a field called "Pop1990" from a joined table called "Demog", you should used "Demog.Pop1990" for the field name in the query filter used in the search method.
The Recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single row object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a row object returned by a recycling cursor across multiple calls to NextRow on the cursor. Row objects returned by a recycling cursor should not be modified.
Non-recycling cursors return a separate row object on each fetch. The objects returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The geodatabase guarantees 'unique instance semantics' on non-recycling feature objects fetched during an edit session.
Recycling cursors should be used only for drawing and read-only access to object state. Use non-recycling search cursors to fetch objects that are to be updated.
searchDisplayTable in interface IDisplayTablepQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter,
int selType,
int selOption,
IWorkspace pSelWorkspace)
throws IOException,
AutomationException
selectDisplayTable in interface IDisplayTablepQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)pSelWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet getDisplaySelectionSet()
throws IOException,
AutomationException
getDisplaySelectionSet in interface IDisplayTableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getJoinType()
throws IOException,
AutomationException
Indicates the type of the most recent join.
getJoinType in interface IDisplayRelationshipClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRelationshipClass getRelationshipClass()
throws IOException,
AutomationException
The relationship class that defines the tables that are joined.
You can also use IFeatureLayerDefinition::RelationshipClass to get a reference to the relationship class that defines a layer join.
getRelationshipClass in interface IDisplayRelationshipClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void displayRelationshipClass(IRelationshipClass relClass,
int joinType)
throws IOException,
AutomationException
RelClass can be either a file or memory based relationship class, but must be defined on the base feature class.
This method internally initializes a RelQueryTable to perform a join. relClass can be can be either a predefined relationship class in a geodatabase or an in memory relationship class. For more information on relationship clases, see IRelationshipClass
displayRelationshipClass in interface IDisplayRelationshipClassrelClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)joinType - A com.esri.arcgis.geodatabase.esriJoinType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getFieldCount()
throws IOException,
AutomationException
getFieldCount in interface ITableFieldsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IField getField(int index)
throws IOException,
AutomationException
getField in interface ITableFieldsindex - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFieldInfo getFieldInfo(int index)
throws IOException,
AutomationException
getFieldInfo in interface ITableFieldsindex - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int findField(String fieldName)
throws IOException,
AutomationException
findField in interface IClassfindField in interface ITableFieldsfieldName - The fieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumRelationshipClass getRelationshipClasses()
throws IOException,
AutomationException
getRelationshipClasses in interface IRelationshipClassCollectionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass,
int role)
throws IOException,
AutomationException
findRelationshipClasses in interface IRelationshipClassCollectionobjectClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addRelationshipClass(IRelationshipClass relationshipClass)
throws IOException,
AutomationException
addRelationshipClass in interface IRelationshipClassCollectionEditrelationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeRelationshipClass(IRelationshipClass relationshipClass)
throws IOException,
AutomationException
removeRelationshipClass in interface IRelationshipClassCollectionEditrelationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeAllRelationshipClasses()
throws IOException,
AutomationException
removeAllRelationshipClasses in interface IRelationshipClassCollectionEditIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet getSelectionSet()
throws IOException,
AutomationException
getSelectionSet in interface ITableSelectionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSelectionSetByRef(ISelectionSet selectionSet)
throws IOException,
AutomationException
setSelectionSetByRef in interface ITableSelectionselectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addRow(IRow row)
throws IOException,
AutomationException
addRow in interface ITableSelectionrow - A reference to a com.esri.arcgis.geodatabase.IRow (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void selectRows(IQueryFilter filter,
int method,
boolean justOne)
throws IOException,
AutomationException
The justOne parameter tells the search to stop once it has found one feature.
selectRows in interface ITableSelectionfilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)justOne - The justOne (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void clear()
throws IOException,
AutomationException
clear in interface ITableSelectionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void selectionChanged()
throws IOException,
AutomationException
selectionChanged in interface ITableSelectionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRow createRow()
throws IOException,
AutomationException
The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.
The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller’s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.
createRow in interface ITableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRow getRow(int oID)
throws IOException,
AutomationException
The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.
getRow in interface ITableoID - The oID (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor getRows(Object oids,
boolean recycling)
throws IOException,
AutomationException
The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.
The oids parameter should be passed an integer array. For example:
// Get a recycling cursor for the OID array.
int[] oids = new int[] { 10844, 10853, 10871 };
ICursor cursor = table.getRows(oids, true);
getRows in interface ITableoids - A Variant (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRowBuffer createRowBuffer()
throws IOException,
AutomationException
The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.
createRowBuffer in interface ITableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void updateSearchedRows(IQueryFilter queryFilter,
IRowBuffer buffer)
throws IOException,
AutomationException
This method will edit the rows matching the query filter's constraints. The values in each row will be replaced with the corresponding field's value in the provided row buffer. The fields being edited should be specified in the query filter's SubFields property. If the row buffer contains null values, and the SubFields property is not properly set, the row's values will be overwritten with the row buffer's null values.
updateSearchedRows in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteSearchedRows(IQueryFilter queryFilter)
throws IOException,
AutomationException
deleteSearchedRows in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int rowCount(IQueryFilter queryFilter)
throws IOException,
AutomationException
rowCount in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor ITable_search(IQueryFilter queryFilter,
boolean recycling)
throws IOException,
AutomationException
ITable_search in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor update(IQueryFilter queryFilter,
boolean recycling)
throws IOException,
AutomationException
The Update method returns an update cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for complex objects and features.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
update in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling - The recycling (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor insert(boolean useBuffering)
throws IOException,
AutomationException
The Insert method returns an insert cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).
Insert cursors on tables containing complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
insert in interface ITableuseBuffering - The useBuffering (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet select(IQueryFilter queryFilter,
int selType,
int selOption,
IWorkspace selectionContainer)
throws IOException,
AutomationException
The Select method returns a selection set that holds either row IDs or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).
The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.
When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.
select in interface ITablequeryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)selectionContainer - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getFields()
throws IOException,
AutomationException
getFields in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IIndexes getIndexes()
throws IOException,
AutomationException
getIndexes in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addField(IField field)
throws IOException,
AutomationException
Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.
addField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteField(IField field)
throws IOException,
AutomationException
DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:
Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
// Assume we have a reference to a FeatureClass (pFC) IFields pFields; IField pField; pFields = pFC.getFields(); pField = pFields.getField(pFields.findField("MyField")); pFC.deleteField(pField);
deleteField in interface IClassfield - A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addIndex(IIndex index)
throws IOException,
AutomationException
Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
addIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteIndex(IIndex index)
throws IOException,
AutomationException
Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
deleteIndex in interface IClassindex - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isHasOID()
throws IOException,
AutomationException
isHasOID in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getOIDFieldName()
throws IOException,
AutomationException
getOIDFieldName in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getCLSID()
throws IOException,
AutomationException
getCLSID in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getEXTCLSID()
throws IOException,
AutomationException
getEXTCLSID in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getExtension()
throws IOException,
AutomationException
getExtension in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getExtensionProperties()
throws IOException,
AutomationException
getExtensionProperties in interface IClassIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getFullName()
throws IOException,
AutomationException
getFullName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getBrowseName()
throws IOException,
AutomationException
getBrowseName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBrowseName(String name)
throws IOException,
AutomationException
setBrowseName in interface IDatasetname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getType()
throws IOException,
AutomationException
// Assume we have a reference to an IfeatureClass (pFeatureClass) IDataset pDataset = null;
pDataset = new IDatasetProxy(pFeatureClass);
System.out.println(pDataset.getName() + " " + pDataset.getType());
if(pFeatureClass != null){
pDataset = pFeatureClass.getFeatureDataset();
System.out.println(pDataset.getName() + " " + pDataset.getType());
}
pDataset = new IDatasetProxy(pDataset.getWorkspace());
System.out.println(pDataset.getName() + " " +
pDataset.getType());
getType in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCategory()
throws IOException,
AutomationException
IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".
The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.
getCategory in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumDataset getSubsets()
throws IOException,
AutomationException
The Subsets property returns other Dataset objects contained in this dataset.
IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.
getSubsets in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IWorkspace getWorkspace()
throws IOException,
AutomationException
The Workspace property returns the containing workspace for this dataset.
getWorkspace in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getPropertySet()
throws IOException,
AutomationException
The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.
Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.
Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.
IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.
getPropertySet in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canCopy()
throws IOException,
AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
The CanCopy method is supported by:
canCopy in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDataset copy(String copyName,
IWorkspace copyWorkspace)
throws IOException,
AutomationException
IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.
copy in interface IDatasetcopyName - The copyName (in)copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canDelete()
throws IOException,
AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canDelete in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void delete()
throws IOException,
AutomationException
Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
delete in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canRename()
throws IOException,
AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canRename in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void rename(String name)
throws IOException,
AutomationException
IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.
rename in interface IDatasetname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
throws IOException,
AutomationException
onAddField in interface IObjectClassSchemaEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
throws IOException,
AutomationException
onDeleteField in interface IObjectClassSchemaEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
throws IOException,
AutomationException
onBehaviorChanged in interface IObjectClassSchemaEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getDataSourceName()
throws IOException,
AutomationException
getDataSourceName in interface IDataLayergetDataSourceName in interface IDataLayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDataSourceName(IName name)
throws IOException,
AutomationException
setDataSourceName in interface IDataLayersetDataSourceName in interface IDataLayer2name - A reference to a com.esri.arcgis.system.IName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDataSourceSupported(IName name)
throws IOException,
AutomationException
isDataSourceSupported in interface IDataLayerisDataSourceSupported in interface IDataLayer2name - A reference to a com.esri.arcgis.system.IName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean connect(IName pOptRepairName)
throws IOException,
AutomationException
connect in interface IDataLayerconnect in interface IDataLayer2pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getRelativeBase()
throws IOException,
AutomationException
The RelativeBase property is used internally when persisting and loading documents with a relative path. When a document has been fully loaded the path is realized to a complete path.
getRelativeBase in interface IDataLayergetRelativeBase in interface IDataLayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRelativeBase(String basePath)
throws IOException,
AutomationException
setRelativeBase in interface IDataLayersetRelativeBase in interface IDataLayer2basePath - The basePath (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void disconnect()
throws IOException,
AutomationException
disconnect in interface IDataLayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean inWorkspace(IWorkspace workspace)
throws IOException,
AutomationException
inWorkspace in interface IDataLayer2workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable getAttributeTable()
throws IOException,
AutomationException
getAttributeTable in interface IAttributeTableIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints in interface IConnectionPointContainerppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint in interface IConnectionPointContainerriid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getDefinitionExpression()
throws IOException,
AutomationException
getDefinitionExpression in interface ITableDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefinitionExpression(String expression)
throws IOException,
AutomationException
setDefinitionExpression in interface ITableDefinitionexpression - The expression (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet getDefinitionSelectionSet()
throws IOException,
AutomationException
getDefinitionSelectionSet in interface ITableDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportsTime()
throws IOException,
AutomationException
This property indicates whether the layer is able to render time-related data. If this property is false, it means that time-related data cannot be handled by the underlying software.
isSupportsTime in interface ITimeDataIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUseTime()
throws IOException,
AutomationException
This property indicates whether the meta-data used to properly configure time-related rendering has been provided. The property is also used to indicate whether the layer should use the time-related meta-data to render time-related data. If the property is false, it can mean two things:
1. The layer has not yet been provided with information like the name of the attribute in the data which contains the time of each feature.
2. The layer has simply been told not to display time-related data. This may be a temporary state change desired by a user that does not want the layer to change when running an animation.
isUseTime in interface ITimeDataIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseTime(boolean useTime)
throws IOException,
AutomationException
setUseTime in interface ITimeDatauseTime - The useTime (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITimeReference getTimeReference()
throws IOException,
AutomationException
This is the time reference for the data that this layer is rendering/providing. This property is read-only in the ITimeData interface because not all layers have the ability to change the TimeReference property of the data they represent. If the layer has the ability to change this property, it will implement the ITimeTableDefinition interface, and through that interface provide the ability to change the property's value.
getTimeReference in interface ITimeDatagetTimeReference in interface ITimeDimensionDefinitiongetTimeReference in interface ITimeTableDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITimeExtent getFullTimeExtent()
throws IOException,
AutomationException
This property provides a TimeExtent which represents the time from the earliest time stamp in the data to the latests time stamp in the data.
getFullTimeExtent in interface ITimeDataIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getStartTimeFieldName()
throws IOException,
AutomationException
This property contains the name of the column which contains the start time for each feature. If the feature has only one associated time, then this field is used, and the EndTimeFieldName is not set.
getStartTimeFieldName in interface ITimeTableDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setStartTimeFieldName(String fieldName)
throws IOException,
AutomationException
setStartTimeFieldName in interface ITimeTableDefinitionfieldName - The fieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getEndTimeFieldName()
throws IOException,
AutomationException
If the data in a table has a start and an end time, this property contains the name of the column that holds the end time for each feature. If the data only has one time associated with it (it is instantaneous) then this property is not set.
getEndTimeFieldName in interface ITimeTableDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEndTimeFieldName(String fieldName)
throws IOException,
AutomationException
setEndTimeFieldName in interface ITimeTableDefinitionfieldName - The fieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTimeValueFormat()
throws IOException,
AutomationException
This property contains an emumeration representing the format of the data stored in the Start Time Field and the End Time Field. The Start Time Field and the End Time Field must use the same format. Only formats allowed by this enumeration are allowed.
getTimeValueFormat in interface ITimeTableDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeValueFormat(String format)
throws IOException,
AutomationException
setTimeValueFormat in interface ITimeTableDefinitionformat - The format (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTrackIDFieldName()
throws IOException,
AutomationException
The TrackIDFieldName property contains the name of the field which can be used to group features by the object they represent. For example, if a table contains observations of automobiles, and each feature in the table represents the location of one automobile at one point in time, there will be one field that uniquely identifies which automobile a feature is associated with (e.g. license plate number). The TrackIDFieldName is the field that can be used to group the attributes by the real-world object that they represent (the "Track" that they belong to).
getTrackIDFieldName in interface ITimeTableDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTrackIDFieldName(String fieldName)
throws IOException,
AutomationException
setTrackIDFieldName in interface ITimeTableDefinitionfieldName - The fieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeReferenceByRef(ITimeReference nativeTimeReference)
throws IOException,
AutomationException
setTimeReferenceByRef in interface ITimeDimensionDefinitionsetTimeReferenceByRef in interface ITimeTableDefinitionnativeTimeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITimeExtent getCustomTimeExtent()
throws IOException,
AutomationException
getCustomTimeExtent in interface ITimeTableDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime)
throws IOException,
AutomationException
setCustomTimeExtentByRef in interface ITimeTableDefinitionlayerVisibiltyTime - A reference to a com.esri.arcgis.system.ITimeExtent (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isMultiDimensional()
throws IOException,
AutomationException
isMultiDimensional in interface ITimeDimensionDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTimeDimensionName()
throws IOException,
AutomationException
getTimeDimensionName in interface ITimeDimensionDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeDimensionName(String fieldName)
throws IOException,
AutomationException
setTimeDimensionName in interface ITimeDimensionDefinitionfieldName - The fieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTimeDimensionFormat()
throws IOException,
AutomationException
getTimeDimensionFormat in interface ITimeDimensionDefinitionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeDimensionFormat(String format)
throws IOException,
AutomationException
setTimeDimensionFormat in interface ITimeDimensionDefinitionformat - The format (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeDataCumulative(boolean cumilative)
throws IOException,
AutomationException
setTimeDataCumulative in interface ITimeDataDisplaycumilative - The cumilative (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isTimeDataCumulative()
throws IOException,
AutomationException
TimeDataCumulative is true when the data should be persist on the display as it ages. This is useful in settings where the new data "builds upon" historical data. For example when displaying the location of a wild animal, this property will cause the layer to display all of the historical locations for the animal, providing a good view of the animal's territory.
isTimeDataCumulative in interface ITimeDataDisplayIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeInterval(double interval)
throws IOException,
AutomationException
setTimeInterval in interface ITimeDataDisplayinterval - The interval (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getTimeInterval()
throws IOException,
AutomationException
This property represents the time interval of the data used when rendering the layer. The time interval represents the minimum expected time between changes in the data. For example, when using weather imagery that is updated every 10 minutes, you would set the time interval to 10 minutes. When using census data that is recorded every year, the time interval would be set to 1 year. Note that this property is the value of the interval, and must be set along with the units for the time interval.
getTimeInterval in interface ITimeDataDisplayIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeIntervalUnits(int units)
throws IOException,
AutomationException
setTimeIntervalUnits in interface ITimeDataDisplayunits - A com.esri.arcgis.system.esriTimeUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getTimeIntervalUnits()
throws IOException,
AutomationException
This property is the enumerated value representing the time units used when measuring the time interval. This property should be read/written along with the time interval value. For more information about the time interval, see the documentation on the TimeInterval property.
getTimeIntervalUnits in interface ITimeDataDisplayIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeOffset(double timeOffset)
throws IOException,
AutomationException
setTimeOffset in interface ITimeDataDisplaytimeOffset - The timeOffset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getTimeOffset()
throws IOException,
AutomationException
The TimeOffset is used to display data at a different time on the timeline. This is for temporary purposes only. It can be useful for comparing data sets from different time period when you need to display the two sets of data together. For example, to visualize the growth pattern of two wild fires that happened in two different years, one of the layers can be given an offset that will cause it to appear as if the fire started at the same time as the other fire. In this way the growth patterns can be seen together, and compared.
getTimeOffset in interface ITimeDataDisplayIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeOffsetUnits(int units)
throws IOException,
AutomationException
setTimeOffsetUnits in interface ITimeDataDisplayunits - A com.esri.arcgis.system.esriTimeUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getTimeOffsetUnits()
throws IOException,
AutomationException
This property is the enumerated value representing the time units used when measuring the time offset. This property should be read/written along with the time offset value. For more information about the time offset, see the documentation on the TimeOffset property.
getTimeOffsetUnits in interface ITimeDataDisplayIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDisplayExpressionProperties getExpressionProperties()
throws IOException,
AutomationException
getExpressionProperties in interface IDisplayStringIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)
throws IOException,
AutomationException
setExpressionPropertiesByRef in interface IDisplayStringdisplayExpressionProperties - A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String findDisplayString(IObject pObject)
throws IOException,
AutomationException
findDisplayString in interface IDisplayStringpObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFieldInfoSet getFieldInfos()
throws IOException,
AutomationException
getFieldInfos in interface IOrderedLayerFieldsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFieldOrder(IFieldInfoSet fieldInfoSet)
throws IOException,
AutomationException
setFieldOrder in interface IOrderedLayerFieldsfieldInfoSet - A reference to a com.esri.arcgis.carto.IFieldInfoSet (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void prepareTimeQuery(ITimeValue pTimeValue,
IQueryFilter[] pFilter)
throws IOException,
AutomationException
prepareTimeQuery in interface ITimeDisplayTablepTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in/out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||