|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.datasourcesfile.DEVPFTable
public class DEVPFTable
VPFTable Data Element object.
Constructor Summary | |
---|---|
DEVPFTable()
Constructs a DEVPFTable using ArcGIS Engine. |
|
DEVPFTable(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. DEVPFTable theDEVPFTable = (DEVPFTable) obj; |
Method Summary | |
---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
Object |
describe(String name)
The description of the named object. |
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML. |
void |
empty()
Clears the value object. |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
String |
getAsText()
Provides the value of the value object. |
String |
getBaseName()
File base name. |
String |
getCatalogPath()
The string used to retrieve the element. |
IArray |
getChildren()
The list of sub-elements. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
int |
getDatasetType()
Dataset type. |
int |
getDSID()
The id of the dataset. |
String |
getExtension()
File extension. |
IFields |
getFields()
The list of Fields. |
String |
getFile()
File name. |
IIndexes |
getIndexes()
The list of Indexes. |
IPropertySet |
getMetadata()
The PropertySet containing metadata. |
String |
getOIDFieldName()
The name of the OID Field. |
String |
getPath()
File path. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
hashCode()
the hashcode for this object |
String |
IDataElement_getName()
The user assigned name for the element. |
String |
IDataElement_getType()
The type of the element. |
IGPDataType |
IGPValue_getDataType()
The data type of the value object. |
boolean |
isCanVersion()
Indicates if this dataset can be versioned. |
boolean |
isChildrenExpanded()
Indicates if the children have been expanded. |
void |
isDirty()
isDirty |
boolean |
isEmpty()
Indicates if the value object is empty. |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isFullPropsRetrieved()
Indicates if full properties have been retrieved. |
boolean |
isHasOID()
Indicates if the table has an object id field. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isMetadataRetrieved()
Indicates if the metadata has been retrieved. |
boolean |
isVersioned()
Indicates if this dataset is versioned. |
void |
load(IStream pstm)
load |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
IGPMessage |
setAsText(String text)
Provides the value of the value object with the given string value. |
void |
setCanVersion(boolean canVersion)
Indicates if this dataset can be versioned. |
void |
setCatalogPath(String path)
The string used to retrieve the element. |
void |
setChildrenByRef(IArray dataElements)
The list of sub-elements. |
void |
setChildrenExpanded(boolean childrenExpanded)
Indicates if the children have been expanded. |
void |
setDatasetType(int type)
Dataset type. |
void |
setDSID(int dSID)
The id of the dataset. |
void |
setFieldsByRef(IFields fields)
The list of Fields. |
void |
setFullPropsRetrieved(boolean fullPropsRetrieved)
Indicates if full properties have been retrieved. |
void |
setHasOID(boolean hasOID)
Indicates if the table has an object id field. |
void |
setIndexesByRef(IIndexes indexes)
The list of Indexes. |
void |
setMetadata(IPropertySet ppPropertySet)
The PropertySet containing metadata. |
void |
setMetadataRetrieved(boolean metadataRetrieved)
Indicates if the metadata has been retrieved. |
void |
setName(String name)
The user assigned name for the element. |
void |
setOIDFieldName(String oIDFieldName)
The name of the OID Field. |
void |
setType(String type)
The type of the element. |
void |
setVersioned(boolean versioned)
Indicates if this dataset is versioned. |
void |
synchronize(int action,
int interval)
Updates metadata with the current properties; may create metadata if it doesn't already exist. |
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 DEVPFTable() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic DEVPFTable(Object obj) throws IOException
DEVPFTable theDEVPFTable = (DEVPFTable) obj;
obj
to DEVPFTable
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public boolean isHasOID() throws IOException, AutomationException
isHasOID
in interface IDETable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHasOID(boolean hasOID) throws IOException, AutomationException
setHasOID
in interface IDETable
hasOID
- The hasOID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getOIDFieldName() throws IOException, AutomationException
getOIDFieldName
in interface IDETable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOIDFieldName(String oIDFieldName) throws IOException, AutomationException
setOIDFieldName
in interface IDETable
oIDFieldName
- The oIDFieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IIndexes getIndexes() throws IOException, AutomationException
getIndexes
in interface IDETable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setIndexesByRef(IIndexes indexes) throws IOException, AutomationException
setIndexesByRef
in interface IDETable
indexes
- A reference to a com.esri.arcgis.geodatabase.IIndexes (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFields getFields() throws IOException, AutomationException
getFields
in interface IDETable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFieldsByRef(IFields fields) throws IOException, AutomationException
setFieldsByRef
in interface IDETable
fields
- A reference to a com.esri.arcgis.geodatabase.IFields (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getDatasetType() throws IOException, AutomationException
getDatasetType
in interface IDEDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDatasetType(int type) throws IOException, AutomationException
setDatasetType
in interface IDEDataset
type
- A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVersioned() throws IOException, AutomationException
isVersioned
in interface IDEDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVersioned(boolean versioned) throws IOException, AutomationException
setVersioned
in interface IDEDataset
versioned
- The versioned (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getDSID() throws IOException, AutomationException
getDSID
in interface IDEDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDSID(int dSID) throws IOException, AutomationException
setDSID
in interface IDEDataset
dSID
- The dSID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanVersion() throws IOException, AutomationException
isCanVersion
in interface IDEDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCanVersion(boolean canVersion) throws IOException, AutomationException
setCanVersion
in interface IDEDataset
canVersion
- The canVersion (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String IDataElement_getType() throws IOException, AutomationException
IDataElement_getType
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setType(String type) throws IOException, AutomationException
setType
in interface IDataElement
type
- The type (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String IDataElement_getName() throws IOException, AutomationException
IDataElement_getName
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface IDataElement
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCatalogPath() throws IOException, AutomationException
Dataset Type | Keyword |
---|---|
Feature dataset | FD |
Feature class | FC |
Object class | OC |
Relationship class | RC |
Geometric network | GN |
Topology | TOPO |
Raster band | RB |
Raster dataset | RD |
Raster catalog | RCAT |
Toolbox | TB |
The following are sample catalog paths:
getCatalogPath
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCatalogPath(String path) throws IOException, AutomationException
setCatalogPath
in interface IDataElement
path
- The path (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray getChildren() throws IOException, AutomationException
getChildren
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setChildrenByRef(IArray dataElements) throws IOException, AutomationException
setChildrenByRef
in interface IDataElement
dataElements
- A reference to a com.esri.arcgis.system.IArray (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isChildrenExpanded() throws IOException, AutomationException
isChildrenExpanded
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setChildrenExpanded(boolean childrenExpanded) throws IOException, AutomationException
setChildrenExpanded
in interface IDataElement
childrenExpanded
- The childrenExpanded (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isMetadataRetrieved() throws IOException, AutomationException
isMetadataRetrieved
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMetadataRetrieved(boolean metadataRetrieved) throws IOException, AutomationException
setMetadataRetrieved
in interface IDataElement
metadataRetrieved
- The metadataRetrieved (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isFullPropsRetrieved() throws IOException, AutomationException
isFullPropsRetrieved
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFullPropsRetrieved(boolean fullPropsRetrieved) throws IOException, AutomationException
setFullPropsRetrieved
in interface IDataElement
fullPropsRetrieved
- The fullPropsRetrieved (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getPath() throws IOException, AutomationException
getPath
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getFile() throws IOException, AutomationException
getFile
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getBaseName() throws IOException, AutomationException
getBaseName
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getExtension() throws IOException, AutomationException
getExtension
in interface IDataElement
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getMetadata() throws IOException, AutomationException
The variable to hold the data must be of IPropertySet data type.
The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.
getMetadata
in interface IMetadata
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMetadata(IPropertySet ppPropertySet) throws IOException, AutomationException
setMetadata
in interface IMetadata
ppPropertySet
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void synchronize(int action, int interval) throws IOException, AutomationException
The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.
The following actions will result in synchronization given each of the listed conditions:
Action | Metadata status | Esri/Sync element | Interval parameter |
---|---|---|---|
esriMSAAccessed | Doesn't matter | Must not be FALSE | Must be less than actual interval |
esriMSAAlways | Doesn't matter | Doesn't matter | Doesn't matter |
esriMSACreated | Must not exist | Must not be FALSE | Must be less than actual interval |
esriMSANotCreated | Must exist | Must not be FALSE | Must be less than actual interval |
esriMSAOverwrite | Doesn't matter | Doesn't matter | Doesn't matter |
The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.
synchronize
in interface IMetadata
action
- A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)interval
- The interval (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPDataType IGPValue_getDataType() throws IOException, AutomationException
IGPValue_getDataType
in interface IGPValue
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEmpty() throws IOException, AutomationException
The IsEmpty method returns if this Value object has been set or not.
isEmpty
in interface IGPValue
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void empty() throws IOException, AutomationException
The Empty method clears this Value object and releases any associated objects.
empty
in interface IGPValue
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getAsText() throws IOException, AutomationException
The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.
getAsText
in interface IGPValue
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPMessage setAsText(String text) throws IOException, AutomationException
The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.
setAsText
in interface IGPValue
text
- The text (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws IOException, AutomationException
esri_clone
in interface IClone
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws IOException, AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws IOException, AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
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 IPersistStream
IOException
- 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 IPersistStream
pstm
- 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 IPersistStream
pstm
- 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 IPersistStream
pcbSize
- 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 getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- 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 Object describe(String name) throws IOException, AutomationException
describe
in interface IGPDescribe
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |