oracle.ifs.common

Class SortQualifier

java.lang.Object

oracle.ifs.common.SortQualifier

All Implemented Interfaces:

Serializable

public final class SortQualifier
extends Object
implements Serializable

A SortQualifer encapsulates the specification of the sort of a single attribute.

One or more SortQualifiers is associated with a SortSpecification, to enable the creation of a SQL order by clause associated with various queries used in iFS.

Version:

1.0

Author:

Dave Long

See Also:

Serialized Form

(Published)

Constructor Summary

Constructors

Constructor and Description
SortQualifier(String sortAttr, boolean sortOrder) Constructs a SortQualifier for a simple qualifier of Attribute and sort direction.
SortQualifier(String sortAttr, boolean sortOrder, String sortClass, String sortAlias, String sqlFunction) Construct a SortQualifier for complex qualifiers.

Method Summary

Modifier and Type	Method and Description
String	getAttributeName() Gets the Attribute name.
String	getClassAlias() Get the alias for the sort attribute's class
String	getClassName() Gets the sort attribute's class name.
protected String	getColumnName() Gets the column name that will be used for this qualifier.
boolean	getSortOrder() Gets the sort order.
protected String	getSqlFunction() Get the SQL function to apply on this qualifier.
protected void	resolve(LibrarySessionInterface sess, SortSpecification sortspec) Resolve the column name to be used for this sort qualifier.
protected void	unresolve() Marks this instance as unresolved.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortQualifier

public SortQualifier(String sortAttr,
                     boolean sortOrder)
              throws IfsException

Constructs a SortQualifier for a simple qualifier of Attribute and sort direction.

The Attribute's ClassObject is assumed to be the default set on the parent SortSpecification. No class alias is used, nor is any SQL function applied to the qualifier.

Parameters:

sortAttr - the sort attribute name

sortOrder - the corresponding sort order

Throws:

IfsException - if operation fails.

(Published)

SortQualifier

public SortQualifier(String sortAttr,
                     boolean sortOrder,
                     String sortClass,
                     String sortAlias,
                     String sqlFunction)
              throws IfsException

Construct a SortQualifier for complex qualifiers.

Parameters:

sortAttr - the sort attribute name

sortOrder - the corresponding sort order; true means ascending, false is desceding.

sortClass - the sort attribute's class name

sortAlias - an alias for the sort attribute's class

sqlFunction - SQL function to apply to the qualifier, or null for no function

Throws:

IfsException - if operation fails.

(Published)

Method Detail

getAttributeName

public String getAttributeName()
                        throws IfsException

Gets the Attribute name.

Returns:

the sort attribute name

Throws:

IfsException - if operation fails.

(Published)

getSortOrder

public boolean getSortOrder()
                     throws IfsException

Gets the sort order.

If it returns true, ascending order is being used. If false, descending order is in use.

Returns:

the sort order

Throws:

IfsException - if operation fails.

(Published)

getClassName

public String getClassName()
                    throws IfsException

Gets the sort attribute's class name.

Returns:

the sort attribute's class name

Throws:

IfsException - if operation fails.

(Published)

getClassAlias

public String getClassAlias()
                     throws IfsException

Get the alias for the sort attribute's class

Returns:

alias for the sort attribute's class

Throws:

IfsException - if operation fails.

(Published)

getColumnName

protected String getColumnName()
                        throws IfsException

Gets the column name that will be used for this qualifier.

Returns:

the column name

Throws:

IfsException - if operation fails.

(Unpublished)

getSqlFunction

protected String getSqlFunction()
                         throws IfsException

Get the SQL function to apply on this qualifier.

Returns:

the SQL function, or null is no function is to be applied

Throws:

IfsException - if operation fails.

(Published)

resolve

protected void resolve(LibrarySessionInterface sess,
                       SortSpecification sortspec)
                throws IfsException

Resolve the column name to be used for this sort qualifier.

Parameters:

sess - Session context

sortspec - the referencing sort specification

Throws:

IfsException - if operation fails.

(Unpublished)

unresolve

protected void unresolve()

Marks this instance as unresolved.

Clears the m_ColumnName and m_ClassName members only if the class wasn't specified explicitly.

(Unpublished)