wt.query
Class NavigateSpec

java.lang.Object
  wt.query.QuerySpec
      wt.query.NavigateSpec

All Implemented Interfaces:

Cloneable, Externalizable, Serializable, StatementSpec

public class NavigateSpec

extends QuerySpec

implements Externalizable

This class implements a specification for a navigate query.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private boolean	navigateEventCompatible
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
static int	ROLE_FROM_INDEX Role class from index.
(package private) static long	serialVersionUID

Fields inherited from class wt.query.QuerySpec

LINK_FROM_INDEX

Fields inherited from interface wt.pds.StatementSpec

ADVANCED_QUERY, ADVANCED_QUERY_ENABLED, AGGREGATE_SELECT, CORRELATED_CLASS_ATTRIBUTES, FETCH_SIZE, PRIMARY_CLASS, QUERY_LIMIT, RESULT_BUILDER, RESULT_CURSOR, SINGLE_RESULT_COMPATIBLE, STATEMENT_BUILDER, USE_BIND

Constructor Summary

NavigateSpec()
This constructor initializes the instance.

NavigateSpec(Class a_linkClass, String a_role, Object a_source)
This constructor initializes the instance.

NavigateSpec(QuerySpec a_querySpec, String a_role, Object a_source)
This constructor initializes the instance.

Method Summary

Object	getSource() Gets the value of the attribute: source; Object source to navigate from.
private void	initializeClasses(Class a_linkClass, String a_role)
boolean	isNavigateEventCompatible() Gets the value of the attribute: navigateEventCompatible; This attribute indicates if this specification should generate Navigate events when exectued.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(NavigateSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setNavigateEventCompatible(boolean a_NavigateEventCompatible) Sets the value of the attribute: navigateEventCompatible; This attribute indicates if this specification should generate Navigate events when exectued.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.query.QuerySpec

addClassList, appendAnd, appendClassList, appendCloseParen, appendCondition, appendCorrelatedClassAttributes, appendFrom, appendGroupBy, appendGroupBy, appendHaving, appendHint, appendJoin, appendJoin, appendNot, appendOpenParen, appendOr, appendOrderBy, appendOrderBy, appendOrderBy, appendOrderBy, appendOrderBy, appendRowNumCondition, appendSearchCondition, appendSearchCondition, appendSelect, appendSelect, appendSelect, appendSelect, appendSelectAttribute, appendSelectReference, appendSelectReference, appendSelectReference, appendSelectReference, appendWhere, appendWhere, appendWhere, appendWhere, appendWhere, clone, clone, getBindParameterAt, getBindParameterCount, getClassAt, getConditionCount, getCorrelatedClassAttributes, getDepthThreshold, getFetchSize, getFromClause, getGroupBy, getGroupByClause, getHavingClause, getHintsVector, getJoinOrder, getOrderBy, getOrderByClause, getPrimaryClass, getQueryLimit, getResultBuilder, getResultCursor, getResultIndex, getResultIndicies, getSelect, getStatementBuilder, getWhere, getWhereClause, initialize, isAdvancedQuery, isAdvancedQueryEnabled, isAggregateSelect, isDistinct, isLock, isQuerySet, isSingleResultCompatible, isTargetPersistable, isUseBind, readVersion, setAdvancedQueryEnabled, setBindParameterAt, setDepthThreshold, setDescendantQuery, setDescendantsIncluded, setDistinct, setFetchSize, setJoinOrder, setJoinOrderAt, setLocale, setLock, setQueryLimit, setQuerySet, setSelect, setUseBind, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

ROLE_FROM_INDEX

public static final int ROLE_FROM_INDEX

Role class from index.

Supported API: false

See Also:

Constant Field Values

navigateEventCompatible

private boolean navigateEventCompatible

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

NavigateSpec

public NavigateSpec(QuerySpec a_querySpec,
                    String a_role,
                    Object a_source)
             throws WTException,
                    WTPropertyVetoException

This constructor initializes the instance.

Supported API: false

Parameters:

a_querySpec - QuerySpec to use for initial criteria.

a_role - The role to navigate.

a_source - Object that specfies the source of the navigation.

Throws:

WTException

WTPropertyVetoException

NavigateSpec

public NavigateSpec(Class a_linkClass,
                    String a_role,
                    Object a_source)
             throws WTException,
                    WTPropertyVetoException

This constructor initializes the instance.

Supported API: false

Parameters:

a_linkClass - Link class to navigate.

a_role - The role to navigate.

a_source - Object that specfies the source of the navigation.

Throws:

WTException

WTPropertyVetoException

NavigateSpec

public NavigateSpec()
             throws QueryException

This constructor initializes the instance.

Supported API: false

Throws:

QueryException

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class QuerySpec

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class QuerySpec

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(NavigateSpec thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

isNavigateEventCompatible

public boolean isNavigateEventCompatible()

Gets the value of the attribute: navigateEventCompatible; This attribute indicates if this specification should generate Navigate events when exectued.

Supported API: false

Returns:

boolean

setNavigateEventCompatible

public void setNavigateEventCompatible(boolean a_NavigateEventCompatible)
                                throws WTPropertyVetoException

Sets the value of the attribute: navigateEventCompatible; This attribute indicates if this specification should generate Navigate events when exectued.

Supported API: false

Parameters:

a_NavigateEventCompatible -

Throws:

WTPropertyVetoException

getSource

public Object getSource()

Gets the value of the attribute: source; Object source to navigate from.

Supported API: false

Returns:

Object

initializeClasses

private void initializeClasses(Class a_linkClass,
                               String a_role)
                        throws WTException

Throws:

WTException