Oracle Data-aware Controls Reference

oracle.dacf.dataset
Class QueryCriteriaAttribute

java.lang.Object
  |
  +--oracle.dacf.dataset.DacObject
        |
        +--oracle.dacf.dataset.ProducerObject
              |
              +--oracle.dacf.dataset.QueryCriteriaAttribute
All Implemented Interfaces:
java.lang.Cloneable

public class QueryCriteriaAttribute
extends ProducerObject

QueryCriteriaAttribute

Version:
SDK: since JDeveloper 3.1

Fields inherited from class oracle.dacf.dataset.ProducerObject
_openLock
 
Fields inherited from class oracle.dacf.dataset.DacObject
EMPTY_PREFIX, INITIAL_CAPACITY, ITEMNAME_DELIMITER
 
Constructor Summary
  QueryCriteriaAttribute()
           
protected QueryCriteriaAttribute(java.lang.String name)
           
protected QueryCriteriaAttribute(java.lang.String n, QueryCriteria p, ProducerObject[] c)
           
 
Method Summary
protected  void closeCheck()
          Checks to see if close is permitted.
protected  void closeChildren()
          A subclass specific method for disconnecting the child objects from their server objects counterparts.
protected  void closeDataItems()
          A subclass specific method for disconnecting and revoking Dataitems Internal to the framework; should never be called by client classes
protected  void closeProducerObject()
          A subclass specific method for disconnecting the client object from the appropriate server objects.
protected  java.lang.String genCloneName()
          Used by the clone method to generate a name for the clone.
protected  oracle.jbo.AttributeDef getAttributeDef()
          Returns the AttributeRef associated with this ColumnInfo's parent.
 int getColumnAlignment()
          Returns column horizontal alignment used for display.
 int getColumnIndex()
          Returns the index of the column within the underlying rowset.
 int getColumnWidth()
          Returns the column width used for display.
protected  javax.infobus.DataItem getDataItem()
          Returns this object's DataItem.
 java.lang.String getFormatString()
          Gets the format string currently in use.
 Formatter getFormatter()
          Gets the Formatter currently in use.
 FormatterInfo getFormatterInfo()
          Returns the information necessary for formatting the Attribute value.
 java.lang.String getLabel()
          Gets the label to use as the column title or prompt.
 int getSQLType()
          Gets the java.sql.Types of this attribute.
 boolean isUpdateable()
           
protected  void openChildren()
          A subclass specific method for connecting the child objects to their server counterparts.
protected  void openDataItems()
          A subclass specific method for connecting the Dataitems Internal to the framework; should never be called by client classes
protected  void openProducerObject()
          A subclass specific method for connecting the client object from the appropriate server objects.
 void setColumnAlignment(int columnAlignment)
          Specifies the column horizontal alignment.
 void setColumnWidth(int columnWidth)
          Specifies the column width for display.
 void setFormatString(java.lang.String formatString)
          Sets the formatter string to be used for formatting.
 void setFormatter(Formatter formatterToUse)
          Sets the Formatter to be used.
 void setFormatterInfo(FormatterInfo formatterInfo)
          Sets info necessary for formatting the Attribute value.
 void setLabel(java.lang.String label)
          Sets the label to use as a column title or prompt.
 void setSQLType(int SQLType)
          Sets the java.sql.Types of this attribute.
 
Methods inherited from class oracle.dacf.dataset.ProducerObject
addChild, addClonedDataItem, clone, close, findDataItem, findProducerObject, findProducerObject, getClonedDataItems, getDataItemImpl, getDataProducer, getDataSourceName, getFullName, isAClonedDataItem, isOpen, open, publishDataItem, publishDataItem, removeChild, removeClonedDataItem, revokeDataItem, setClonedDataItems, setDataItem, setDataSourceName, setName, setOpen
 
Methods inherited from class oracle.dacf.dataset.DacObject
addChild, findDescendant, getChild, getChildIndex, getChildren, getName, getNumOfChildren, getParent, getPrefix, insertChildAt, removeChild, removeChildren, setChildren, setParent, setPrefix
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueryCriteriaAttribute

public QueryCriteriaAttribute()

QueryCriteriaAttribute

protected QueryCriteriaAttribute(java.lang.String name)

QueryCriteriaAttribute

protected QueryCriteriaAttribute(java.lang.String n,
                                 QueryCriteria p,
                                 ProducerObject[] c)
Method Detail

isUpdateable

public boolean isUpdateable()

openProducerObject

protected void openProducerObject()
Description copied from class: ProducerObject
A subclass specific method for connecting the client object from the appropriate server objects. Internal to the framework; should never be called by client classes
Overrides:
openProducerObject in class ProducerObject

openChildren

protected void openChildren()
Description copied from class: ProducerObject
A subclass specific method for connecting the child objects to their server counterparts. Internal to the framework; should never be called by client classes
Overrides:
openChildren in class ProducerObject

openDataItems

protected void openDataItems()
Description copied from class: ProducerObject
A subclass specific method for connecting the Dataitems Internal to the framework; should never be called by client classes
Overrides:
openDataItems in class ProducerObject

closeCheck

protected void closeCheck()
Description copied from class: ProducerObject
Checks to see if close is permitted.

Internal to the framework; should never be called by client classes

Overrides:
closeCheck in class ProducerObject
Following copied from class: oracle.dacf.dataset.ProducerObject
Throws:
DataSourceOperationException - Occurs when closing isn't allowed.

closeProducerObject

protected void closeProducerObject()
Description copied from class: ProducerObject
A subclass specific method for disconnecting the client object from the appropriate server objects. Internal to the framework; should never be called by client classes
Overrides:
closeProducerObject in class ProducerObject

closeChildren

protected void closeChildren()
Description copied from class: ProducerObject
A subclass specific method for disconnecting the child objects from their server objects counterparts. Internal to the framework; should never be called by client classes
Overrides:
closeChildren in class ProducerObject

closeDataItems

protected void closeDataItems()
Description copied from class: ProducerObject
A subclass specific method for disconnecting and revoking Dataitems Internal to the framework; should never be called by client classes
Overrides:
closeDataItems in class ProducerObject

getDataItem

protected javax.infobus.DataItem getDataItem()
Description copied from class: ProducerObject
Returns this object's DataItem.

A side effect of getDataItem is that if the DataItem does not already exist, it will be created.

This method in all cases will be overridden to handle the particulars of creating the specific type of DataItem associated with each subclass.

Overrides:
getDataItem in class ProducerObject

getColumnIndex

public int getColumnIndex()
Returns the index of the column within the underlying rowset.

This method should not be called until after the RowSet has been opened. If it is called before the rowset has been opened, it will return -1.

Returns:
the index of the column within the underlying rowset; -1 if the underlying rowset has not been opened yet.

setSQLType

public void setSQLType(int SQLType)
Sets the java.sql.Types of this attribute.
Parameters:
SQLType - the data type of the attribute.
See Also:
Types

getSQLType

public int getSQLType()
Gets the java.sql.Types of this attribute.
Returns:
the data type of the attribute.
See Also:
Types

setColumnWidth

public void setColumnWidth(int columnWidth)
Specifies the column width for display.
Parameters:
width - the column width.

getColumnWidth

public int getColumnWidth()
Returns the column width used for display.
Returns:
the column width.

setColumnAlignment

public void setColumnAlignment(int columnAlignment)
Specifies the column horizontal alignment.
Parameters:
alignment - DEFAULT is the default, which will use LEFT for text and dates, and RIGHT for numbers. Can also be one of the following constants defined in SwingConstants:
  • LEFT (the default for text and dates)
  • CENTER, RIGHT (the default for numbers)
  • LEADING or TRAILING

getColumnAlignment

public int getColumnAlignment()
Returns column horizontal alignment used for display.
Returns:
the column alignment.

setFormatter

public void setFormatter(Formatter formatterToUse)
Sets the Formatter to be used.
Parameters:
formatterToUse - a formatter object.

getFormatter

public Formatter getFormatter()
Gets the Formatter currently in use.
Returns:
formatter object currently in use.

setFormatString

public void setFormatString(java.lang.String formatString)
Sets the formatter string to be used for formatting.
Parameters:
formatString - format string to use.

getFormatString

public java.lang.String getFormatString()
Gets the format string currently in use.
Returns:
format string currently in use.

setFormatterInfo

public void setFormatterInfo(FormatterInfo formatterInfo)
Sets info necessary for formatting the Attribute value.

Bean Property editors use this method to set Formatter and the Format string.

Parameters:
FormatterInfo - formatter and format string value to use.

getFormatterInfo

public FormatterInfo getFormatterInfo()
Returns the information necessary for formatting the Attribute value.

Bean property editors use this method to edit the Formatter property.


setLabel

public void setLabel(java.lang.String label)
Sets the label to use as a column title or prompt.
Parameters:
label - the column label to use.

getLabel

public java.lang.String getLabel()
Gets the label to use as the column title or prompt.
Returns:
the column label.

genCloneName

protected java.lang.String genCloneName()
Used by the clone method to generate a name for the clone.
Overrides:
genCloneName in class DacObject

getAttributeDef

protected oracle.jbo.AttributeDef getAttributeDef()
Returns the AttributeRef associated with this ColumnInfo's parent.
Returns:
the AttributeRef.

Oracle Data-aware Controls Reference