|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geodatabase.TableQueryName
public class TableQueryName
Esri Table Query Name object.
Constructor Summary | |
---|---|
TableQueryName()
Constructs a TableQueryName using ArcGIS Engine. |
|
TableQueryName(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TableQueryName theTableQueryName = (TableQueryName) obj; |
Method Summary | |
---|---|
boolean |
equals(Object o)
Compare this object with another |
String |
getCategory()
The category of the dataset. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
String |
getName()
The name of the dataset. |
String |
getNameString()
The name string of the object. |
String |
getPrimaryKey()
The primary key field names. |
IQueryDef |
getQueryDef()
QueryDef of feature class name. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
IEnumDatasetName |
getSubsetNames()
Subset names contained within this dataset name. |
int |
getType()
The type of the dataset. |
IWorkspaceName |
getWorkspaceName()
The WorkspaceName of the DatasetName. |
int |
hashCode()
the hashcode for this object |
boolean |
isCopyLocally()
Indicates if the data must be copied locally. |
void |
isDirty()
isDirty |
void |
load(IStream pstm)
load |
Object |
open()
Opens the object referred to by this name. |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setCategory(String category)
The category of the dataset. |
void |
setCopyLocally(boolean copyLocally)
Indicates if the data must be copied locally. |
void |
setName(String name)
The name of the dataset. |
void |
setNameString(String nameString)
The name string of the object. |
void |
setPrimaryKey(String fieldNames)
The primary key field names. |
void |
setQueryDef(IQueryDef queryDef)
QueryDef of feature class name. |
void |
setWorkspaceNameByRef(IWorkspaceName workspaceName)
The WorkspaceName of the DatasetName. |
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 TableQueryName() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic TableQueryName(Object obj) throws IOException
TableQueryName theTableQueryName = (TableQueryName) obj;
obj
to TableQueryName
.
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 void setNameString(String nameString) throws IOException, AutomationException
The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.
setNameString
in interface IName
nameString
- The nameString (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getNameString() throws IOException, AutomationException
The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.
getNameString
in interface IName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object open() throws IOException, AutomationException
The Open method lets you instantiate the actual object given the name object.
Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.
IName pName = pFeatureClassName;
pFeatureClass = new IFeatureClassProxy(pName.open());
open
in interface IName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface IDatasetName
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 IDatasetName
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getType() throws IOException, AutomationException
getType
in interface IDatasetName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCategory() throws IOException, AutomationException
getCategory
in interface IDatasetName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCategory(String category) throws IOException, AutomationException
setCategory
in interface IDatasetName
category
- The category (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspaceName getWorkspaceName() throws IOException, AutomationException
getWorkspaceName
in interface IDatasetName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setWorkspaceNameByRef(IWorkspaceName workspaceName) throws IOException, AutomationException
setWorkspaceNameByRef
in interface IDatasetName
workspaceName
- A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumDatasetName getSubsetNames() throws IOException, AutomationException
getSubsetNames
in interface IDatasetName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IQueryDef getQueryDef() throws IOException, AutomationException
public void IQueryName__(IWorkspace
workspace)
{
IFeatureWorkspace
featureWorkspace = (IFeatureWorkspace)workspace;
IQueryDef queryDef =
featureWorkspace.CreateQueryDef();
//examples of query def
construction
//Valid sub
fields
queryDef.SubFields =
"Parcel.Area, Parcel.Parcel_ID";
//Invalid sub fields
//queryDef.SubFields =
"max(Parcel.Area) as Max_Area";
//Valid tables
queryDef.Tables =
"Parcels, Owners";
//Invalid tables
//queryDef.Tables =
"Parcels p, Owners o";
//queryDef.Tables =
"Owners INNER JOIN parcels ON Owners.Parcel_id =
parcels.Parcel_id";
//Valid where
clause
queryDef.WhereClause =
"Owner.Name like '%Smith%' and Owner.Address like '%Main
Street%'";
//Invalid where
clause
//queryDef.WhereClause =
"Owner.Name like '%Smith%' group by Owner.City_Address";
//set QueryDef
property
IQueryName queryName =
new TableQueryNameClass();
queryName.QueryDef =
queryDef;
}
The IQueryDef::Subfields, IQueryDef::Tables and IQueryDef::WhereClause properties of the QueryDef are used to generate a SQL statement. This is executed against the database to return the rows represented by the table or feature class opened from the name object. If the QueryDef properties are not set properly, you may get errors or incorrect results. The following describes how to define these properties properly:
IQueryDef::Subfields - This must be a comma delimited list of field names or a * to indicate all columns. Column aliases and functions are invalid.
IQueryDef::Tables - This needs to be a comma delimited list of tables. Join statements or table aliases are invalid.
IQueryDef::WhereClause - Most WhereClauses are valid, but additonal statements like Order by and Group by are not.
See the IQueryDef interface for more information on QueryDefs.
getQueryDef
in interface IQueryName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setQueryDef(IQueryDef queryDef) throws IOException, AutomationException
public void IQueryName__(IWorkspace workspace)
{
IFeatureWorkspace featureWorkspace = (IFeatureWorkspace)workspace;
IQueryDef queryDef = featureWorkspace.CreateQueryDef();
//examples of query def construction
//Valid sub fields
queryDef.SubFields = "Parcel.Area, Parcel.Parcel_ID";
//Invalid sub fields
//queryDef.SubFields = "max(Parcel.Area) as Max_Area";
//Valid tables
queryDef.Tables = "Parcels, Owners";
//Invalid tables
//queryDef.Tables = "Parcels p, Owners o";
//queryDef.Tables = "Owners INNER JOIN parcels ON Owners.Parcel_id = parcels.Parcel_id";
//Valid where clause
queryDef.WhereClause = "Owner.Name like '%Smith%' and Owner.Address like '%Main Street%'";
//Invalid where clause
//queryDef.WhereClause = "Owner.Name like '%Smith%' group by Owner.City_Address";
//set QueryDef property
IQueryName queryName = new TableQueryNameClass();
queryName.QueryDef = queryDef;
}
setQueryDef
in interface IQueryName
queryDef
- A reference to a com.esri.arcgis.geodatabase.IQueryDef (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCopyLocally(boolean copyLocally) throws IOException, AutomationException
setCopyLocally
in interface IQueryName2
copyLocally
- The copyLocally (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IQueryName2.getPrimaryKey()
,
IQueryName2
public boolean isCopyLocally() throws IOException, AutomationException
By default, CopyLocally is set to False.
isCopyLocally
in interface IQueryName2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPrimaryKey(String fieldNames) throws IOException, AutomationException
setPrimaryKey
in interface IQueryName2
fieldNames
- The fieldNames (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getPrimaryKey() throws IOException, AutomationException
The name of the field or fields to use for assigning Object ID's to the rows in the QueryDef. Provide a comma delimited string of field names for cases where more than one field is needed to provide a unique value for each row (i.e. composite keys)
Always provide fully qualified field names.
getPrimaryKey
in interface IQueryName2
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 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 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 |