com.esri.arcgis.schematic
Class NgAttributeQuery

java.lang.Object
  com.esri.arcgis.schematic.NgAttributeQuery

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INgAttribute, INgAttributeQuery, Serializable

public class NgAttributeQuery
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgAttributeQuery, INgAttribute

Attribute query object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NgAttributeQuery(Object obj)
Construct a NgAttributeQuery using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	delete() Deletes the attribute.
boolean	equals(Object o) Compare this object with another
INgDataSource	getDataSource() Data source used by the query.
String	getFieldName() Name of the field related to the attribute query.
String	getName() Name of the attribute query.
INgObjectType	getObjectType() Object type the attribute is related to.
INgParameters	getParameters() List of the parameters used by the query.
String	getQueryString() Query, name of the query, or name of the table that returnes the field associated with the attribute query.
int	getType() Type of the attribute.
int	hashCode() the hashcode for this object
void	setDataSource(INgDataSource pVal) Data source used by the query.
void	setFieldName(String pVal) Name of the field related to the attribute query.
void	setName(String pVal) Name of the attribute query.
void	setParameters(INgParameters pVal) List of the parameters used by the query.
void	setQueryString(String pVal) Query, name of the query, or name of the table that returnes the field associated with the attribute query.

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

NgAttributeQuery

public NgAttributeQuery(Object obj)
                 throws IOException

Construct a NgAttributeQuery using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgAttributeQuery.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NgAttributeQuery o = (NgAttributeQuery)obj; // will not work

NgAttributeQuery o = new NgAttributeQuery(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems NgAttributeQuery theNgAttributeQuery = (NgAttributeQuery) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the attribute query.

Description

This name is defined when the query attribute is created
- either by calling the INgObjectType CreateAttribute method in the program code,
- or through ArcGIS Schematics Designer, when the attribute has been created.

Product Availability

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

Specified by:

getName in interface INgAttribute

Specified by:

getName in interface INgAttributeQuery

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException

Name of the attribute query.

Product Availability

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

Specified by:

setName in interface INgAttribute

Specified by:

setName in interface INgAttributeQuery

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldName

public String getFieldName()
                    throws IOException,
                           AutomationException

Name of the field related to the attribute query.

Product Availability

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

Specified by:

getFieldName in interface INgAttributeQuery

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldName

public void setFieldName(String pVal)
                  throws IOException,
                         AutomationException

Name of the field related to the attribute query.

Product Availability

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

Specified by:

setFieldName in interface INgAttributeQuery

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSource

public INgDataSource getDataSource()
                            throws IOException,
                                   AutomationException

Data source used by the query.

Product Availability

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

Specified by:

getDataSource in interface INgAttributeQuery

Returns:

A reference to a com.esri.arcgis.schematic.INgDataSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSource

public void setDataSource(INgDataSource pVal)
                   throws IOException,
                          AutomationException

Data source used by the query.

Product Availability

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

Specified by:

setDataSource in interface INgAttributeQuery

Parameters:

pVal - A reference to a com.esri.arcgis.schematic.INgDataSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryString

public String getQueryString()
                      throws IOException,
                             AutomationException

Query, name of the query, or name of the table that returnes the field associated with the attribute query.

Product Availability

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

Specified by:

getQueryString in interface INgAttributeQuery

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryString

public void setQueryString(String pVal)
                    throws IOException,
                           AutomationException

Query, name of the query, or name of the table that returnes the field associated with the attribute query.

Product Availability

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

Specified by:

setQueryString in interface INgAttributeQuery

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

public INgParameters getParameters()
                            throws IOException,
                                   AutomationException

List of the parameters used by the query.

Product Availability

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

Specified by:

getParameters in interface INgAttributeQuery

Returns:

A reference to a com.esri.arcgis.schematic.INgParameters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameters

public void setParameters(INgParameters pVal)
                   throws IOException,
                          AutomationException

List of the parameters used by the query.

Product Availability

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

Specified by:

setParameters in interface INgAttributeQuery

Parameters:

pVal - A reference to a com.esri.arcgis.schematic.INgParameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

Type of the attribute.

Description

The attribute type is defined when the attribute is created:
- either by calling the INgObjectType CreateAttribute method in the program code,
- or through ArcGIS Schematics Designer, when the attribute has been created.

Seven types of attributes are available:

• esriNgConstantAttribute, for an attribute whose value is a constant
• esriNgFieldAttribute, for an attribute whose values become from a field or a set of fields returned by the query set for its related object type
• esriNgFormattedAttribute, for an attribute whose values are built by formatting other attributes values and/or string,
• esriNgFunctionAttribute, for an attribute whose values are computed by a function
• esriNgGeometryAttribute, for an attribute whose value is a geometric information decoded from an ESRI BLOB
• esriNgQueryAttribute, for an attribute whose value is returned by a query other than the query set for its related object type
• esriNgByFunctionsAttribute,
• esriNgListPointsAttribute,
• esriNgPropertySetAttribute, for an attribute whose values is stored in a PropertySet

Remarks

Attributes of a given type have their own characteristics. You can specify these characteristics through their specific interface INgAttributeConstant, INgAttributeField, INgAttributeFormatted, INgAttributeFunction, INgAttributeGeometry, or INgAttributeQuery.

Product Availability

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

Specified by:

getType in interface INgAttribute

Returns:

A com.esri.arcgis.schematic.esriNgAttributeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectType

public INgObjectType getObjectType()
                            throws IOException,
                                   AutomationException

Object type the attribute is related to.

Product Availability

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

Specified by:

getObjectType in interface INgAttribute

Returns:

A reference to a com.esri.arcgis.schematic.INgObjectType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes the attribute.

Product Availability

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

Specified by:

delete in interface INgAttribute

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.