oracle.ifs.common

Class ColumnDescriptor

java.lang.Object

oracle.ifs.common.ColumnDescriptor

public final class ColumnDescriptor
extends Object

A ColumnDescriptor describes a column that is selected in a PreparedSelect.

Author:

Dave Long

(Published)

Constructor Summary

Constructors

Constructor and Description
ColumnDescriptor(AttributeValueTable avt, LibrarySession session) Constructs a ColumnDescriptor using a table containing the definitions.
ColumnDescriptor(LibrarySession session, String colAlias, String targAlias, String className, String attrName) Constructs a ColumnDescriptor using column alias, target (table) alias, ClassObject name, and Attribute name.
ColumnDescriptor(LibrarySession session, String colAlias, String targAlias, String className, String attrName, String objIdAlias) Constructs a ColumnDescriptor using column alias, target (table) alias, ClassObject name, and Attribute name, and an optional Object ID alias.
ColumnDescriptor(String colAlias, String targAlias, Attribute attr) Constructs a ColumnDescriptor using column alias, target (table) alias, and Attribute.
ColumnDescriptor(String colAlias, String targAlias, Attribute attr, String objIdAlias) Constructs a ColumnDescriptor using column alias, target (table) alias, and Attribute, and an optional Object ID alias.
ColumnDescriptor(String colAlias, String qualColumn, int dataType) Constructs a ColumnDescriptor using column alias, qualified column name, and data type.

Method Summary

Modifier and Type	Method and Description
static ColumnDescriptor	createForClassID(String colAlias, String targAlias) Constructs a ColumnDescriptor for the CLASSID of the specified target alias.
static ColumnDescriptor	createForEntireLibraryObject(LibrarySession session, String colAlias, String targAlias, String classObjName) Constructs a ColumnDescriptor for selecting an entire object for a primary or auxiliary search target that represents a ClassObject.
static ColumnDescriptor	createForEntireLibraryObject(String colAlias, String targAlias, ClassObject classObj) Constructs a ColumnDescriptor for selecting an entire object for a primary or auxiliary search target that represents a ClassObject.
static ColumnDescriptor	createForID(String colAlias, String targAlias) Constructs a ColumnDescriptor for the ID of the specified target alias.
static ColumnDescriptor	createForNonAttribute(String colAlias, String qualColumn, int dataType) Constructs a ColumnDescriptor for non-Attributes.
static ColumnDescriptor	createForNonScalarAttribute(LibrarySession session, String colAlias, String targAlias, String className, String attrName, String objIdAlias) Constructs a ColumnDescriptor for a non-scalar Attribute, currently Attribute's whose data type is an array or map type.
static ColumnDescriptor	createForNonScalarAttribute(String colAlias, String targAlias, Attribute attr, String objIdAlias) Constructs a ColumnDescriptor for a non-scalar Attribute, currently Attribute's whose data type is an array or map type.
static ColumnDescriptor	createForScalarAttribute(LibrarySession session, String colAlias, String targAlias, String className, String attrName) Constructs a ColumnDescriptor for a scalar Attribute.
static ColumnDescriptor	createForScalarAttribute(String colAlias, String targAlias, Attribute attr) Constructs a ColumnDescriptor for a scalar Attribute.
Attribute	getAttribute(LibrarySession sess) Gets Attribute for the selected column, when the instance represents a single Attribute to be selected.
Long	getAttributeId() Gets the associated attribute ID for the selected column.
Long	getClassId() Gets Class ID for the selected column.
ClassObject	getClassObject(LibrarySession sess) Gets ClassObject for the selected column, when entire object should be selected.
String	getColumnAlias() Gets the column alias name (used in AS clause).
int	getDataType() Gets the data type to use for the selected column.
long	getObjectId(AttributeValueTable rowTable) Gets the object ID for the specified row, using this object's Object ID alias.
String	getObjectIdAlias() Gets the alias for the ColumnDescriptor that references the object ID for the same search target as this column uses.
String	getOriginalAttributeName() Gets the original attribute name (specified during construction) to use for the selected column.
String	getOriginalClassName() Gets the original class name (specified during construction) to use for the selected column.
String	getOriginalDataTypeString() Gets the original data type label (specified during construction) to use for the selected column.
String	getOriginalQualifiedColumn() Gets the original Column name (specified during construction) qualified with the table/view alias, e.g.
String	getOriginalSearchTargetAlias() Gets the original search target alias (specified during construction) to use for the selected column.
Long	getPrimaryClassId() Gets the class ID reflecting a ClassDomain setting (for SimpleObjects).
String	getQualifiedColumn() Gets the column name qualified with the table/view alias, e.g.
String	getTargetAlias() Gets the target alias name.
boolean	isLiteralQualifiedColumnSpecified() Gets whether the qualified Column name was specified literally.
boolean	isSelectLibaryObjectSpecified() Gets whether the column represents a selected LibraryObject.
void	overwriteQualifiedColumn(String qualColumn) Overwrite the column name qualified with the specified String.
void	replaceAlias(String actualAlias) Overwrite the qualified column to use the alias specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnDescriptor

public ColumnDescriptor(AttributeValueTable avt,
                        LibrarySession session)
                 throws IfsException

Constructs a ColumnDescriptor using a table containing the definitions.

Parameters:

avt - the options table

session - the sesson context

Throws:

IfsException - if operation fails.

(Published)

ColumnDescriptor

public ColumnDescriptor(String colAlias,
                        String qualColumn,
                        int dataType)
                 throws IfsException

Constructs a ColumnDescriptor using column alias, qualified column name, and data type.

Parameters:

colAlias - the selected column alias (used in AS clause)

qualColumn - the column qualified with the table alias, e.g. "d.name"

dataType - the data type to use for the selected column

Throws:

IfsException - if operation fails.

(Published)

ColumnDescriptor

public ColumnDescriptor(String colAlias,
                        String targAlias,
                        Attribute attr)
                 throws IfsException

Constructs a ColumnDescriptor using column alias, target (table) alias, and Attribute.

Parameters:

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the column

attr - the Attribute that represents the column element

Throws:

IfsException - if operation fails.

(Published)

ColumnDescriptor

public ColumnDescriptor(String colAlias,
                        String targAlias,
                        Attribute attr,
                        String objIdAlias)
                 throws IfsException

Constructs a ColumnDescriptor using column alias, target (table) alias, and Attribute, and an optional Object ID alias.

Parameters:

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the column

attr - the Attribute that represents the column element

objIdAlias - the Object ID alias

Throws:

IfsException - if operation fails.

(Published)

ColumnDescriptor

public ColumnDescriptor(LibrarySession session,
                        String colAlias,
                        String targAlias,
                        String className,
                        String attrName)
                 throws IfsException

Constructs a ColumnDescriptor using column alias, target (table) alias, ClassObject name, and Attribute name.

Parameters:

session - the sesson context

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the column

className - the name of the class for the Attribute specified

attrName - the name of the specified Attribute

Throws:

IfsException - if operation fails.

(Published)

ColumnDescriptor

public ColumnDescriptor(LibrarySession session,
                        String colAlias,
                        String targAlias,
                        String className,
                        String attrName,
                        String objIdAlias)
                 throws IfsException

Constructs a ColumnDescriptor using column alias, target (table) alias, ClassObject name, and Attribute name, and an optional Object ID alias.

Parameters:

session - the sesson context

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the column

className - the name of the class for the Attribute specified

attrName - the name of the specified Attribute

objIdAlias - the Object ID alias

Throws:

IfsException - if operation fails.

(Published)

Method Detail

createForScalarAttribute

public static ColumnDescriptor createForScalarAttribute(String colAlias,
                                                        String targAlias,
                                                        Attribute attr)
                                                 throws IfsException

Constructs a ColumnDescriptor for a scalar Attribute.

Parameters:

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the column

attr - the Attribute that represents the column element

Returns:

the newly constructed ColumnDescriptor

Throws:

IfsException - if operation fails.

(Published)

createForScalarAttribute

public static ColumnDescriptor createForScalarAttribute(LibrarySession session,
                                                        String colAlias,
                                                        String targAlias,
                                                        String className,
                                                        String attrName)
                                                 throws IfsException

Constructs a ColumnDescriptor for a scalar Attribute.

Parameters:

session - the session context

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the column

className - the name of the class for the Attribute specified

attrName - the name of the specified Attribute

Returns:

the newly constructed ColumnDescriptor

Throws:

IfsException - if operation fails.

(Published)

createForID

public static ColumnDescriptor createForID(String colAlias,
                                           String targAlias)
                                    throws IfsException

Constructs a ColumnDescriptor for the ID of the specified target alias.

Parameters:

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the ID column

Returns:

the newly constructed ColumnDescriptor

Throws:

IfsException - if operation fails.

(Published)

createForClassID

public static ColumnDescriptor createForClassID(String colAlias,
                                                String targAlias)
                                         throws IfsException

Constructs a ColumnDescriptor for the CLASSID of the specified target alias.

Parameters:

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the CLASSID column

Returns:

the newly constructed ColumnDescriptor

Throws:

IfsException - if operation fails.

(Published)

createForNonScalarAttribute

public static ColumnDescriptor createForNonScalarAttribute(String colAlias,
                                                           String targAlias,
                                                           Attribute attr,
                                                           String objIdAlias)
                                                    throws IfsException

Constructs a ColumnDescriptor for a non-scalar Attribute, currently Attribute's whose data type is an array or map type.

Parameters:

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the column

attr - the Attribute that represents the column element

objIdAlias - the column alias used to select the ID of the object containing the non-scalar Attribute

Returns:

the newly constructed ColumnDescriptor

Throws:

IfsException - if operation fails.

(Published)

createForNonScalarAttribute

public static ColumnDescriptor createForNonScalarAttribute(LibrarySession session,
                                                           String colAlias,
                                                           String targAlias,
                                                           String className,
                                                           String attrName,
                                                           String objIdAlias)
                                                    throws IfsException

Constructs a ColumnDescriptor for a non-scalar Attribute, currently Attribute's whose data type is an array or map type.

Parameters:

session - the session context

colAlias - the selected column alias (used in AS clause)

targAlias - the target alias containing the column

className - the name of the class for the Attribute specified

attrName - the name of the specified Attribute

objIdAlias - the column alias used to select the ID of the object containing the non-scalar Attribute

Returns:

the newly constructed ColumnDescriptor

Throws:

IfsException - if operation fails.

(Published)

createForEntireLibraryObject

public static ColumnDescriptor createForEntireLibraryObject(String colAlias,
                                                            String targAlias,
                                                            ClassObject classObj)
                                                     throws IfsException

Constructs a ColumnDescriptor for selecting an entire object for a primary or auxiliary search target that represents a ClassObject.

Parameters:

colAlias - the selected column alias (used in AS clause)

targAlias - the alias for the primary/aux target being selected

classObj - the ClassObject

Returns:

the newly constructed ColumnDescriptor

Throws:

IfsException - if operation fails.

(Published)

createForEntireLibraryObject

public static ColumnDescriptor createForEntireLibraryObject(LibrarySession session,
                                                            String colAlias,
                                                            String targAlias,
                                                            String classObjName)
                                                     throws IfsException

Constructs a ColumnDescriptor for selecting an entire object for a primary or auxiliary search target that represents a ClassObject.

Parameters:

session - the session context

colAlias - the selected column alias (used in AS clause)

targAlias - the alias for the primary/aux target being selected

classObjName - the ClassObject name

Returns:

the newly constructed ColumnDescriptor

Throws:

IfsException - if operation fails.

(Published)

createForNonAttribute

public static ColumnDescriptor createForNonAttribute(String colAlias,
                                                     String qualColumn,
                                                     int dataType)
                                              throws IfsException

Constructs a ColumnDescriptor for non-Attributes.

Parameters:

colAlias - the selected column alias (used in AS clause)

qualColumn - the column qualified with the table alias, examples: "d.name", "UPPER(ATTR{cat.CityName})"

dataType - the data type to use for the selected column

Returns:

the newly constructed ColumnDescriptor

Throws:

IfsException - if operation fails.

(Published)

getOriginalQualifiedColumn

public String getOriginalQualifiedColumn()
                                  throws IfsException

Gets the original Column name (specified during construction) qualified with the table/view alias, e.g. "doc.createdate".

Returns:

the original qualified Column name

Throws:

IfsException - if operation fails.

(Published)

getOriginalDataTypeString

public String getOriginalDataTypeString()
                                 throws IfsException

Gets the original data type label (specified during construction) to use for the selected column.

Returns:

the original data type label

Throws:

IfsException - if operation fails.

(Published)

getOriginalClassName

public String getOriginalClassName()
                            throws IfsException

Gets the original class name (specified during construction) to use for the selected column.

Returns:

the original class name

Throws:

IfsException - if operation fails.

(Published)

getOriginalAttributeName

public String getOriginalAttributeName()
                                throws IfsException

Gets the original attribute name (specified during construction) to use for the selected column.

Returns:

the original attribute name

Throws:

IfsException - if operation fails.

(Published)

getOriginalSearchTargetAlias

public String getOriginalSearchTargetAlias()
                                    throws IfsException

Gets the original search target alias (specified during construction) to use for the selected column.

Returns:

the original search target alias

Throws:

IfsException - if operation fails.

(Published)

getColumnAlias

public String getColumnAlias()
                      throws IfsException

Gets the column alias name (used in AS clause).

Returns:

the column alias name

Throws:

IfsException - if operation fails.

(Published)

getTargetAlias

public String getTargetAlias()
                      throws IfsException

Gets the target alias name.

Returns:

the target alias name

Throws:

IfsException - if operation fails.

(Published)

getQualifiedColumn

public String getQualifiedColumn()
                          throws IfsException

Gets the column name qualified with the table/view alias, e.g. "doc.createdate".

Returns:

the qualified column name

Throws:

IfsException - if operation fails.

(Published)

isLiteralQualifiedColumnSpecified

public boolean isLiteralQualifiedColumnSpecified()
                                          throws IfsException

Gets whether the qualified Column name was specified literally.

Returns:

true if the qualified column name was specified literally

Throws:

IfsException - if operation fails.

(Published)

isSelectLibaryObjectSpecified

public boolean isSelectLibaryObjectSpecified()
                                      throws IfsException

Gets whether the column represents a selected LibraryObject.

Returns:

true if this column represents a selected LibraryObject

Throws:

IfsException - if operation fails.

(Published)

getDataType

public int getDataType()
                throws IfsException

Gets the data type to use for the selected column.

Returns:

the data type

Throws:

IfsException - if operation fails.

(Published)

getClassId

public Long getClassId()
                throws IfsException

Gets Class ID for the selected column.

Specified during construction, using variants that indicate that the entire object should be selected.

Returns:

the class ID

Throws:

IfsException - if operation fails.

(Published)

getClassObject

public ClassObject getClassObject(LibrarySession sess)
                           throws IfsException

Gets ClassObject for the selected column, when entire object should be selected.

Parameters:

sess - the session context

Returns:

the ClassObject when entire object should be selected, or null otherwise

Throws:

IfsException - if operation fails.

(Published)

getAttributeId

public Long getAttributeId()
                    throws IfsException

Gets the associated attribute ID for the selected column.

Specified during construction, using variants with an Attribute.

Returns:

the associated attribute ID

Throws:

IfsException - if operation fails.

(Published)

getAttribute

public Attribute getAttribute(LibrarySession sess)
                       throws IfsException

Gets Attribute for the selected column, when the instance represents a single Attribute to be selected.

Parameters:

sess - the session context

Returns:

the Attribute when a single Attribute to be selected, or null otherwise

Throws:

IfsException - if operation fails.

(Published)

getPrimaryClassId

public Long getPrimaryClassId()
                       throws IfsException

Gets the class ID reflecting a ClassDomain setting (for SimpleObjects).

Specified during construction, using variants with an Attribute.

Returns:

the class ID reflecting a ClassDomain setting

Throws:

IfsException - if operation fails.

(Published)

getObjectIdAlias

public String getObjectIdAlias()
                        throws IfsException

Gets the alias for the ColumnDescriptor that references the object ID for the same search target as this column uses.

Specified during construction, using variants with an Object ID alias.

Returns:

the Object ID alias

Throws:

IfsException - if operation fails.

(Published)

getObjectId

public long getObjectId(AttributeValueTable rowTable)
                 throws IfsException

Gets the object ID for the specified row, using this object's Object ID alias.

Parameters:

rowTable - the results for a selectred row

Returns:

the associated object ID

Throws:

IfsException - if operation fails.

(Published)

overwriteQualifiedColumn

public void overwriteQualifiedColumn(String qualColumn)
                              throws IfsException

Overwrite the column name qualified with the specified String.

Used in PreparedSelectorGenerator. Can only be used for instances that were constructed using a literal qualified column value.

Parameters:

qualColumn - the new qualified column name

Throws:

IfsException - if operation fails.

(Published)

replaceAlias

public void replaceAlias(String actualAlias)
                  throws IfsException

Overwrite the qualified column to use the alias specified.

Used when smart views are enabled. Can only be used for instances that were constructed using an Attribute.

Parameters:

actualAlias - the actual alias to use

Throws:

IfsException - if operation fails.

(Published)