com.esri.arcgis.schematic
Class SchematicAttributeQuery

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAttribute, ISchematicAttributeQuery, Serializable

public class SchematicAttributeQuery
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAttributeQuery, ISchematicAttribute

Schematic attribute query object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

void	delete() Deletes the schematic attribute.
boolean	equals(Object o) Compare this object with another
IUID	getCLSID() CLSID of the schematic attribute.
String	getDescription() Description of the schematic attribute.
String	getFieldName() Result field name of the schematic attribute query.
String	getName() Name of the schematic attribute.
String	getQueryString() Query string of the schematic attribute query.
ISchematicDataSource	getSchematicDataSource() Schematic data source of the schematic attribute query.
ISchematicObjectClass	getSchematicObjectClass() Schematic object class the schematic attribute belongs to.
IEnumSchematicQueryParameter	getSchematicQueryParameters() Schematic query parameters of the schematic attribute query.
Object	getValue(ISchematicObject schematicObject) The schematic attribute value for the specified schematic object.
int	hashCode() the hashcode for this object
boolean	isUseAssociatedFeatureDataSource() Indicates if the query must use the associted feature datasource (useful to query the same version).
void	setFieldName(String fieldName) Result field name of the schematic attribute query.
void	setName(String name) Name of the schematic attribute.
void	setQueryString(String queryString) Query string of the schematic attribute query.
void	setSchematicDataSourceByRef(ISchematicDataSource schematicDataSource) Schematic data source of the schematic attribute query.
void	setSchematicQueryParameters(IEnumSchematicQueryParameter queryParameters) Schematic query parameters of the schematic attribute query.
void	setUseAssociatedFeatureDataSource(boolean useAssociatedFeatureDataSource) Indicates if the query must use the associted feature datasource (useful to query the same version).

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

SchematicAttributeQuery

public SchematicAttributeQuery(Object obj)
                        throws IOException

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

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

Throws:

IOException - if there are interop problems SchematicAttributeQuery theSchematicAttributeQuery = (SchematicAttributeQuery) 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

getSchematicQueryParameters

public IEnumSchematicQueryParameter getSchematicQueryParameters()
                                                         throws IOException,
                                                                AutomationException

Schematic query parameters of the schematic attribute query.

Product Availability

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

Specified by:

getSchematicQueryParameters in interface ISchematicAttributeQuery

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicQueryParameters

public void setSchematicQueryParameters(IEnumSchematicQueryParameter queryParameters)
                                 throws IOException,
                                        AutomationException

Schematic query parameters of the schematic attribute query.

Product Availability

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

Specified by:

setSchematicQueryParameters in interface ISchematicAttributeQuery

Parameters:

queryParameters - A reference to a com.esri.arcgis.schematic.IEnumSchematicQueryParameter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryString

public String getQueryString()
                      throws IOException,
                             AutomationException

Query string of the schematic attribute query.

Product Availability

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

Specified by:

getQueryString in interface ISchematicAttributeQuery

Returns:

The queryString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryString

public void setQueryString(String queryString)
                    throws IOException,
                           AutomationException

Query string of the schematic attribute query.

Product Availability

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

Specified by:

setQueryString in interface ISchematicAttributeQuery

Parameters:

queryString - The queryString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDataSource

public ISchematicDataSource getSchematicDataSource()
                                            throws IOException,
                                                   AutomationException

Schematic data source of the schematic attribute query.

Product Availability

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

Specified by:

getSchematicDataSource in interface ISchematicAttributeQuery

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDataSourceByRef

public void setSchematicDataSourceByRef(ISchematicDataSource schematicDataSource)
                                 throws IOException,
                                        AutomationException

Schematic data source of the schematic attribute query.

Product Availability

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

Specified by:

setSchematicDataSourceByRef in interface ISchematicAttributeQuery

Parameters:

schematicDataSource - A reference to a com.esri.arcgis.schematic.ISchematicDataSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseAssociatedFeatureDataSource

public boolean isUseAssociatedFeatureDataSource()
                                         throws IOException,
                                                AutomationException

Indicates if the query must use the associted feature datasource (useful to query the same version).

Product Availability

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

Specified by:

isUseAssociatedFeatureDataSource in interface ISchematicAttributeQuery

Returns:

The useAssociatedFeatureDataSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseAssociatedFeatureDataSource

public void setUseAssociatedFeatureDataSource(boolean useAssociatedFeatureDataSource)
                                       throws IOException,
                                              AutomationException

Indicates if the query must use the associted feature datasource (useful to query the same version).

Product Availability

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

Specified by:

setUseAssociatedFeatureDataSource in interface ISchematicAttributeQuery

Parameters:

useAssociatedFeatureDataSource - The useAssociatedFeatureDataSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldName

public String getFieldName()
                    throws IOException,
                           AutomationException

Result field name of the schematic attribute query.

Product Availability

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

Specified by:

getFieldName in interface ISchematicAttributeQuery

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldName

public void setFieldName(String fieldName)
                  throws IOException,
                         AutomationException

Result field name of the schematic attribute query.

Product Availability

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

Specified by:

setFieldName in interface ISchematicAttributeQuery

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the schematic attribute.

Description

A number of schematic feature classes' predefined attributes are used by Schematics. These attributes have predefined names, allowing Schematics to automatically deal with them when they are configured.

Some predefined attributes are completely managed by Schematics by default and automatically stored in system fields in the schematic feature classes in the schematic dataset at the schematic feature creation; for example, spatial or topological attributes.

The table below lists all the predefined attributes that can be configured on schematic feature classes depending on their type:

Predefined attribute name	Schematic feature class Type	Description
AbsolutePosition	Node On Link	absolute position on the reference link
ContainerBottomMargin	Node	container margin at bottom
ContainerLeftMargin	Node	container margin at left
ContainerMargin	Node	constant container margin at right, left, top, and bottom
ContainerMarginSymbolsFlag	Node	indicates whether the margin includes the symbol size
ContainerMarginUnit	Node	container margin unit
ContainerRightMargin	Node	container margin at right
ContainerTopMargin	Node	container margin at top
EndFlag	Node	indicates whether it's an end node schematic feature
ExtremityNode	Link, Sub Link	extremity node or node on link identifier
ExtremityPortNumber	Link, Sub Link	port number on the extremity node or node on link symbol
FCN	Node, Node On Link, Link, Sub Link	name of the feature class or table that contains the GIS feature/object associated with the schematic feature
FDSN	Node, Node On Link, Link, Sub Link	name of the data source to connect the geodatabase that contains the GIS feature/object associated with the schematic feature
FOID	Node, Node On Link, Link, Sub Link	OBJECTID of the GIS feature/object associated with the schematic feature
InitialListPoints	Link	list of initial vertices
InitialXPosition	Node	initial x-coordinate
InitialYPosition	Node	initial y-coordinate
InitialRotation	Node	initial rotation angle in degrees
OriginNode	Link, Sub Link	origin node or node on link identifier
OriginPortNumber	Link, Sub Link	port number on the origin node or node on link symbol
PEN	Node, Node On Link, Link, SubLink	name of the parent schematic feature that is related to the schematic feature; for example, container name
PTN	Node, Node On Link, Link, SubLink	name of the schematic feature class that implements the parent that is related to the schematic feature
ReferenceLink	Node On Link, Sub Link	reference link identifier
RelativePosition	Node On Link	relative position on the reference link
RootFlag	Node	indicates whether it's a root node schematic feature

Product Availability

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

Specified by:

getName in interface ISchematicAttribute

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the schematic attribute.

Product Availability

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

Specified by:

setName in interface ISchematicAttribute

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Description of the schematic attribute.

Product Availability

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

Specified by:

getDescription in interface ISchematicAttribute

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException

CLSID of the schematic attribute.

Product Availability

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

Specified by:

getCLSID in interface ISchematicAttribute

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicObjectClass

public ISchematicObjectClass getSchematicObjectClass()
                                              throws IOException,
                                                     AutomationException

Schematic object class the schematic attribute belongs to.

Product Availability

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

Specified by:

getSchematicObjectClass in interface ISchematicAttribute

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes the schematic attribute.

Product Availability

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

Specified by:

delete in interface ISchematicAttribute

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public Object getValue(ISchematicObject schematicObject)
                throws IOException,
                       AutomationException

The schematic attribute value for the specified schematic object.

Product Availability

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

Specified by:

getValue in interface ISchematicAttribute

Parameters:

schematicObject - A reference to a com.esri.arcgis.schematic.ISchematicObject (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.