oracle.owb.intelligence
Interface QueryItem

All Superinterfaces:

Extensible, OWBNamedObject, PropertyOwner

public interface QueryItem

extends OWBNamedObject, Extensible

A QueryItem represents an item within a Query Object.

Field Summary

static java.lang.String	AXIS AXIS indicates that the default placement for the query item is an axis.
static java.lang.String	CENTER CENTER indicates the query item value should aligned to the center.
static java.lang.String	DEFAULT DEFAULT indicates default alignment for the query item value.
static java.lang.String	INITCAPPED INITCAPPED indicates alphabetic characters should be displayed with the first letter of each word in upper case.
static java.lang.String	LEFT LEFT indicates the query item value should aligned to the left.
static java.lang.String	LOWER LOWER indicates alphabetic characters should be displayed in lower case.
static java.lang.String	MEASURE MEASURE indicates that the default placement for the query item is a measure.
static java.lang.String	RIGHT RIGHT indicates the query item value should aligned to the right.
static java.lang.String	UNCHANGED UNCHANGED indicates alphabetic characters should be displayed unchanged.
static java.lang.String	UNKNOWN UNKNOWN indicates that the default placement for the query item is unknown.
static java.lang.String	UPPER UPPER indicates alphabetic characters should be displayed in upper case.
static java.lang.String	XAXIS XAXIS indicates that the default placement for the query item is the x axis.
static java.lang.String	YAXIS YAXIS indicates that the default placement for the query item is the y axis.
static java.lang.String	ZAXIS ZAXIS indicates that the default placement for the query item is the z (page) axis.

Method Summary

java.lang.String	getAlignment() Returns the alignment for displaying text.
java.lang.String	getCaseDisplay() Returns details on how alphabetic characters should be displayed.
java.lang.String	getDefaultPlacement() Returns the default placement for the query item.
java.lang.String	getDefaultRollupFunction() Returns the name of the default rollup function for the query item.
DrillItem[]	getDrillItems() Returns the list of drill items that reference this query item.
java.lang.String	getExpressionText() Returns the text of the derivation expression for a derived query item.
java.lang.String	getExternalColumnName() Returns the external name for the corresponding column.
java.lang.String	getFormatMask() Returns the format mask for the query item.
java.lang.String	getHeading() Returns the heading text for the query item.
ItemClass	getItemClass() Returns the Item Class that defines the List of Values for this Query Item.
ItemClass[]	getItemClassesDefined() Returns the list of Item Classes that use this query item to define their values.
ItemClass[]	getItemClassesOrdered() Returns the list of Item Classes that use this query item to provide an ordering position for their values.
java.lang.String	getItemDatatype() Returns the datatype for the query item.
JoinComponent[]	getLocalJoinComponents() Returns the list of join components that reference this query item as their 'local' Query Item.
int	getMaxDataWidth() Returns the maximum number of characters allowed for the query item.
int	getMaxDisplayWidth() Returns the maximum number of characters to display.
QueryObject	getQueryObject() Returns the owning query object.
OWBNamedObject	getRelatedAttribute() Returns the related attribute, which may be a Column, a cube Measure, a dimension Level Attribute or another Query Item.
JoinComponent[]	getRemoteJoinComponents() Returns the list of join components that reference this query item as their 'remote' Query Item.
boolean	isHidden() Returns whether the query item should be hidden from the user.
boolean	isWordWrapAllowed() Returns whether wordwrap is allowed.
void	setAlignment(java.lang.String alignment) Sets the alignment for displaying text.
void	setCaseDisplay(java.lang.String caseDisplay) Sets how alphabetic characters should be displayed.
void	setDefaultPlacement(java.lang.String defaultPlacement) Sets the default placement for the query item.
void	setDefaultRollupFunction(java.lang.String defaultRollupFunction) Sets the name of the default rollup function for the query item.
void	setExpressionText(java.lang.String expressionText) Sets the text of the derivation expression for a derived query item.
void	setExternalColumnName(java.lang.String externalColumnName) Sets the external name for the corresponding column.
void	setFormatMask(java.lang.String formatMask) Sets the format mask for the query item.
void	setHeading(java.lang.String heading) Sets the heading text for the query item.
void	setHidden(boolean hidden) Sets whether the query item should be hidden from the user.
void	setItemClass(ItemClass itemClass) Sets an Item Class that defines the List of Values for this Query Item.
void	setItemDatatype(java.lang.String itemDatatype) Sets the datatype for the query item.
void	setMaxDataWidth(int maxDataWidth) Sets the maximum number of characters allowed for the query item.
void	setMaxDisplayWidth(int maxDisplayWidth) Sets the maximum number of characters to display.
void	setRelatedAttribute(OWBNamedObject attribute) Sets the related attribute for the Query Item to reference a Column, a cube Measure, a dimension Level Attribute or another Query Item.
void	setWordWrapAllowed(boolean wordWrapAllowed) Sets whether wordwrap is allowed.

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Field Detail

DEFAULT

public static final java.lang.String DEFAULT

DEFAULT indicates default alignment for the query item value.

See Also:

Constant Field Values

LEFT

public static final java.lang.String LEFT

LEFT indicates the query item value should aligned to the left.

See Also:

Constant Field Values

CENTER

public static final java.lang.String CENTER

CENTER indicates the query item value should aligned to the center.

See Also:

Constant Field Values

RIGHT

public static final java.lang.String RIGHT

RIGHT indicates the query item value should aligned to the right.

See Also:

Constant Field Values

UNCHANGED

public static final java.lang.String UNCHANGED

UNCHANGED indicates alphabetic characters should be displayed unchanged.

See Also:

Constant Field Values

LOWER

public static final java.lang.String LOWER

LOWER indicates alphabetic characters should be displayed in lower case.

See Also:

Constant Field Values

UPPER

public static final java.lang.String UPPER

UPPER indicates alphabetic characters should be displayed in upper case.

See Also:

Constant Field Values

INITCAPPED

public static final java.lang.String INITCAPPED

INITCAPPED indicates alphabetic characters should be displayed with the first letter of each word in upper case.

See Also:

Constant Field Values

UNKNOWN

public static final java.lang.String UNKNOWN

UNKNOWN indicates that the default placement for the query item is unknown.

See Also:

Constant Field Values

MEASURE

public static final java.lang.String MEASURE

MEASURE indicates that the default placement for the query item is a measure.

See Also:

Constant Field Values

AXIS

public static final java.lang.String AXIS

AXIS indicates that the default placement for the query item is an axis.

See Also:

Constant Field Values

XAXIS

public static final java.lang.String XAXIS

XAXIS indicates that the default placement for the query item is the x axis.

See Also:

Constant Field Values

YAXIS

public static final java.lang.String YAXIS

YAXIS indicates that the default placement for the query item is the y axis.

See Also:

Constant Field Values

ZAXIS

public static final java.lang.String ZAXIS

ZAXIS indicates that the default placement for the query item is the z (page) axis.

See Also:

Constant Field Values

Method Detail

getAlignment

public java.lang.String getAlignment()

Returns the alignment for displaying text.

Returns:

a String representing the alignment value for the query item. Possible values are DEFAULT, LEFT, CENTER or RIGHT.

See Also:

setAlignment(java.lang.String)

setAlignment

public void setAlignment(java.lang.String alignment)

Sets the alignment for displaying text.

Parameters:

alignment - a String specifying the alignment value for the query item. Possible values are DEFAULT, LEFT, CENTER or RIGHT.

See Also:

getAlignment()

getCaseDisplay

public java.lang.String getCaseDisplay()

Returns details on how alphabetic characters should be displayed.

Returns:

a String representing the case display value. Possible values are UNCHANGED, LOWER, UPPER or INITCAPPED.

See Also:

setCaseDisplay(java.lang.String)

setCaseDisplay

public void setCaseDisplay(java.lang.String caseDisplay)

Sets how alphabetic characters should be displayed.

Parameters:

caseDisplay - a String specifying the case display value. Possible values are UNCHANGED, LOWER, UPPER or INITCAPPED.

See Also:

getCaseDisplay()

getDefaultPlacement

public java.lang.String getDefaultPlacement()

Returns the default placement for the query item.

Returns:

a String representing the default placement value. Possible values are UNKNOWN, MEASURE, AXIS, XAXIS, YAXIS or ZAXIS.

See Also:

setDefaultPlacement(java.lang.String)

setDefaultPlacement

public void setDefaultPlacement(java.lang.String defaultPlacement)

Sets the default placement for the query item.

Parameters:

defaultPlacement - a String specifying the default placement value. Possible values are UNKNOWN, MEASURE, AXIS, XAXIS, YAXIS or ZAXIS.

See Also:

getDefaultPlacement()

getDefaultRollupFunction

public java.lang.String getDefaultRollupFunction()

Returns the name of the default rollup function for the query item.

Returns:

a String representing the name of the default rollup function.

See Also:

setDefaultRollupFunction(java.lang.String)

setDefaultRollupFunction

public void setDefaultRollupFunction(java.lang.String defaultRollupFunction)

Sets the name of the default rollup function for the query item.

Parameters:

defaultRollupFunction - a String specifying the name of the default rollup function

See Also:

getDefaultRollupFunction()

getExpressionText

public java.lang.String getExpressionText()

Returns the text of the derivation expression for a derived query item.

Returns:

a String representing the expression text.

See Also:

setExpressionText(java.lang.String)

setExpressionText

public void setExpressionText(java.lang.String expressionText)

Sets the text of the derivation expression for a derived query item.

Parameters:

expressionText - a String specifying the expression text.

See Also:

getExpressionText()

getExternalColumnName

public java.lang.String getExternalColumnName()

Returns the external name for the corresponding column. (This is only relevant for a query item that corresponds to a database column.)

Returns:

a String representing the external name for the column.

See Also:

setExternalColumnName(java.lang.String)

setExternalColumnName

public void setExternalColumnName(java.lang.String externalColumnName)

Sets the external name for the corresponding column.

Parameters:

externalColumnName - a String specifying the external name for the column.

See Also:

getExternalColumnName()

getFormatMask

public java.lang.String getFormatMask()

Returns the format mask for the query item. (This influences the way the query item is displayed.)

Returns:

a String representing the format mask value.

See Also:

setFormatMask(java.lang.String)

setFormatMask

public void setFormatMask(java.lang.String formatMask)

Sets the format mask for the query item.

Parameters:

formatMask - a String specifying the format mask value.

See Also:

getFormatMask()

getHeading

public java.lang.String getHeading()

Returns the heading text for the query item.

Returns:

a String representing the heading text.

See Also:

setHeading(java.lang.String)

setHeading

public void setHeading(java.lang.String heading)

Sets the heading text for the query item.

Parameters:

heading - a String specifying the heading text.

See Also:

getHeading()

isHidden

public boolean isHidden()

Returns whether the query item should be hidden from the user.

Returns:

true if this object should be hidden.

See Also:

setHidden(boolean)

setHidden

public void setHidden(boolean hidden)

Sets whether the query item should be hidden from the user.

Parameters:

hidden - true to make this object hidden

See Also:

isHidden()

getItemDatatype

public java.lang.String getItemDatatype()

Returns the datatype for the query item.

Returns:

a String representing the query item's datatype.

See Also:

setItemDatatype(java.lang.String)

setItemDatatype

public void setItemDatatype(java.lang.String itemDatatype)

Sets the datatype for the query item.

Parameters:

itemDatatype - a String specifying the query item's datatype.

See Also:

getItemDatatype()

getMaxDataWidth

public int getMaxDataWidth()

Returns the maximum number of characters allowed for the query item.

Returns:

an int representing the maximum number of characters allowed.

See Also:

setMaxDataWidth(int)

setMaxDataWidth

public void setMaxDataWidth(int maxDataWidth)

Sets the maximum number of characters allowed for the query item.

Parameters:

maxDataWidth - an int specifying the maximum number of characters allowed.

See Also:

getMaxDataWidth()

getMaxDisplayWidth

public int getMaxDisplayWidth()

Returns the maximum number of characters to display.

Returns:

an int representing the maximum number of characters to display.

See Also:

setMaxDisplayWidth(int)

setMaxDisplayWidth

public void setMaxDisplayWidth(int maxDisplayWidth)

Sets the maximum number of characters to display.

Parameters:

maxDisplayWidth - an int specifying the maximum number of characters to display.

See Also:

getMaxDisplayWidth()

isWordWrapAllowed

public boolean isWordWrapAllowed()

Returns whether wordwrap is allowed.

Returns:

true if word wrap is allowed for this query item.

See Also:

setWordWrapAllowed(boolean)

setWordWrapAllowed

public void setWordWrapAllowed(boolean wordWrapAllowed)

Sets whether wordwrap is allowed.

Parameters:

wordWrapAllowed - true to indicate word wrap is allowed.

See Also:

isWordWrapAllowed()

getQueryObject

public QueryObject getQueryObject()

Returns the owning query object.

Returns:

a QueryObject representing the owning query object.

setRelatedAttribute

public void setRelatedAttribute(OWBNamedObject attribute)

Sets the related attribute for the Query Item to reference a Column, a cube Measure, a dimension Level Attribute or another Query Item. (A Query Item of a complex Query Object will normally reference another Query Item.)

Parameters:

attribute - an OWBNamedObject specifying the related attribute. (A null attribute value leaves the related attribute unset.)

See Also:

getRelatedAttribute()

getRelatedAttribute

public OWBNamedObject getRelatedAttribute()

Returns the related attribute, which may be a Column, a cube Measure, a dimension Level Attribute or another Query Item. (A Query Item of a complex Query Object will normally reference another Query Item.)

Returns:

an OWBNamedObject representing the related attribute or null if none.

See Also:

setRelatedAttribute(oracle.owb.foundation.OWBNamedObject)

getDrillItems

public DrillItem[] getDrillItems()

Returns the list of drill items that reference this query item.

Returns:

an array of DrillItem objects representing the drill items.

getLocalJoinComponents

public JoinComponent[] getLocalJoinComponents()

Returns the list of join components that reference this query item as their 'local' Query Item.

Returns:

an array of JoinComponent objects that reference this query item as their 'local' Query Item.

getRemoteJoinComponents

public JoinComponent[] getRemoteJoinComponents()

Returns the list of join components that reference this query item as their 'remote' Query Item.

Returns:

an array of JoinComponent objects that reference this query item as their 'remote' Query Item.

setItemClass

public void setItemClass(ItemClass itemClass)

Sets an Item Class that defines the List of Values for this Query Item.

Parameters:

itemClass - an ItemClass object specifying the List of Values for this Query Item. (A null itemClass value leaves the item class unset.)

See Also:

getItemClass()

getItemClass

public ItemClass getItemClass()

Returns the Item Class that defines the List of Values for this Query Item.

Returns:

an ItemClass object or null if none.

See Also:

setItemClass(oracle.owb.intelligence.ItemClass)

getItemClassesDefined

public ItemClass[] getItemClassesDefined()

Returns the list of Item Classes that use this query item to define their values.

Returns:

an array of ItemClass objects representing the item classes that use this query item to define their values.

getItemClassesOrdered

public ItemClass[] getItemClassesOrdered()

Returns the list of Item Classes that use this query item to provide an ordering position for their values.

Returns:

an array of ItemClass objects representing the item classes that use this query item to provide an ordering position for their values.