DBTableField

java.lang.Object
- org.ecoinformatics.seek.querybuilder.DBTableField

All Implemented Interfaces:

java.awt.datatransfer.Transferable, DBDisplayItemIFace, DSTableFieldIFace
```
public class DBTableField
extends java.lang.Object
implements java.awt.datatransfer.Transferable, DBDisplayItemIFace
```
A field in the table frame. This is an item that can be dragged and dropped

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.awt.datatransfer.DataFlavor[]`	`flavors`
`protected boolean`	`mIsDisplayed`
`protected boolean`	`mIsDragOver`
`protected boolean`	`mIsLinked`
`protected java.util.Vector`	`mMissingValueCode`
`protected java.awt.Dimension`	`mPreferredDim`
`protected java.awt.Rectangle`	`mRect`
`protected DSTableFieldIFace`	`mTableField`
`protected DBTableFrame`	`mTableFrame`

Constructor Summary

Constructors
Constructor and Description

DBTableField()
Default Constructor

DBTableField(DSTableFieldIFace aField, DBTableFrame aOwner)
Constructor

Constructors
Constructor and Description
`DBTableField()` Default Constructor
`DBTableField(DSTableFieldIFace aField, DBTableFrame aOwner)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(java.awt.Point aPnt)` Translates its position via the point
`void`	`addMissingValueCode(java.lang.String code)` Method to add missing value code into a vector.
`java.awt.Rectangle`	`getBounds()` Returns the bounds of the item
`java.lang.String`	`getDataType()` Return the datatype
`boolean`	`getLinked()` Return whether it is a link
`java.util.Vector`	`getMissingValueCode()` Method to return the vector which store the missing value code.
`java.lang.String`	`getName()` Return the name
`java.awt.Dimension`	`getPreferredDim()` Gets the preferred dimension
`DBTableFrame`	`getTable()` Returns the owner object
`DSTableKeyIFace`	`getTableKeyIFace()` Get the iface obj representing the key
`java.lang.String`	`getTableName()` Return the table name (returns the owner's name)
`java.lang.Object`	`getTransferData(java.awt.datatransfer.DataFlavor flavor)` If the data was requested in the "java.lang.String" flavor, return the String representing the selection.
`java.awt.datatransfer.DataFlavor[]`	`getTransferDataFlavors()` Returns the array of flavors in which it can provide the data.
`boolean`	`isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)` Returns whether the requested flavor is supported by this object.
`boolean`	`isDisplayed()` Return whether it is being displayed
`boolean`	`isDragOver()` Returns if it is currently be dragged over
`void`	`setDisplayed(boolean aVal)` Set whether it is displayed or not
`void`	`setDragOver(boolean aVal)` Sets whether it is currently being dragged over
`void`	`setLinked(boolean aVal)` Set whether it is a link or not
`void`	`setMissingValueCode(java.util.Vector missingValueVector)` Method to return the vector which store the missing value code.
`void`	`setPreferredDim(java.awt.Dimension aDim)` Sets the preferred dimension
`void`	`setRect(int x, int y, int w, int h)` Sets the rectangle
`void`	`setRect(java.awt.Rectangle aRect)` Sets the rectangle if the item
`java.lang.String`	`toString()` Returns the actual name or DBUIUtils.ALL_FIELDS if no name

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - mTableField
```
protected DSTableFieldIFace mTableField
```
  - mTableFrame
```
protected DBTableFrame mTableFrame
```
  - mRect
```
protected java.awt.Rectangle mRect
```
  - mIsLinked
```
protected boolean mIsLinked
```
  - mIsDragOver
```
protected boolean mIsDragOver
```
  - mIsDisplayed
```
protected boolean mIsDisplayed
```
  - mPreferredDim
```
protected java.awt.Dimension mPreferredDim
```
  - mMissingValueCode
```
protected java.util.Vector mMissingValueCode
```
  - flavors
```
protected java.awt.datatransfer.DataFlavor[] flavors
```
- Constructor Detail
  - DBTableField
```
public DBTableField()
```
    Default Constructor
  - DBTableField
```
public DBTableField(DSTableFieldIFace aField,
                    DBTableFrame aOwner)
```
    Constructor
    
    Parameters:
    
    aField - the database field
    
    aOwner - the table owning the field
- Method Detail
  - getTableKeyIFace
```
public DSTableKeyIFace getTableKeyIFace()
```
    Get the iface obj representing the key
    
    Returns:
    
    return obj if it is a key, otherwise false
  - getTable
```
public DBTableFrame getTable()
```
    Returns the owner object
    
    Returns:
    
    the owner object
  - setLinked
```
public void setLinked(boolean aVal)
```
    Set whether it is a link or not
    
    Parameters:
    
    aVal - whether is it a link
  - getLinked
```
public boolean getLinked()
```
    Return whether it is a link
    
    Returns:
    
    true if linked
  - setDisplayed
```
public void setDisplayed(boolean aVal)
```
    Set whether it is displayed or not
    
    Specified by:
    
    setDisplayed in interface DBDisplayItemIFace
    
    Parameters:
    
    aVal - true if the display attr is to be set
  - isDisplayed
```
public boolean isDisplayed()
```
    Return whether it is being displayed
    
    Specified by:
    
    isDisplayed in interface DBDisplayItemIFace
    
    Returns:
    
    true if the display attr is set
  - getName
```
public java.lang.String getName()
```
    Return the name
    
    Specified by:
    
    getName in interface DSTableFieldIFace
    
    Returns:
    
    name as a string
  - getTableName
```
public java.lang.String getTableName()
```
    Return the table name (returns the owner's name)
    
    Specified by:
    
    getTableName in interface DBDisplayItemIFace
    
    Returns:
    
    name as a string
  - getDataType
```
public java.lang.String getDataType()
```
    Return the datatype
    
    Specified by:
    
    getDataType in interface DSTableFieldIFace
    
    Returns:
    
    data type per DataDescription class
  - setDragOver
```
public void setDragOver(boolean aVal)
```
    Sets whether it is currently being dragged over
    
    Parameters:
    
    aVal - true if dragged over otherwise false
  - isDragOver
```
public boolean isDragOver()
```
    Returns if it is currently be dragged over
    
    Returns:
    
    true if it is currently be dragged over
  - toString
```
public java.lang.String toString()
```
    Returns the actual name or DBUIUtils.ALL_FIELDS if no name
    
    Overrides:
    
    toString in class java.lang.Object
  - getBounds
```
public java.awt.Rectangle getBounds()
```
    Returns the bounds of the item
    
    Returns:
    
    the bounds
  - setRect
```
public void setRect(java.awt.Rectangle aRect)
```
    Sets the rectangle if the item
    
    Parameters:
    
    aRect -
  - setRect
```
public void setRect(int x,
                    int y,
                    int w,
                    int h)
```
    Sets the rectangle
    
    Parameters:
    
    x - X Do the same as dragOver
    
    y - Y coord
    
    w - Width
    
    h - Height
  - add
```
public void add(java.awt.Point aPnt)
```
    Translates its position via the point
    
    Parameters:
    
    aPnt - the delta point
  - setPreferredDim
```
public void setPreferredDim(java.awt.Dimension aDim)
```
    Sets the preferred dimension
    
    Parameters:
    
    aDim -
  - getPreferredDim
```
public java.awt.Dimension getPreferredDim()
```
    Gets the preferred dimension
    
    Returns:
    
    the dimension
  - getTransferDataFlavors
```
public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()
```
    Returns the array of flavors in which it can provide the data.
    
    Specified by:
    
    getTransferDataFlavors in interface java.awt.datatransfer.Transferable
  - isDataFlavorSupported
```
public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)
```
    Returns whether the requested flavor is supported by this object.
    
    Specified by:
    
    isDataFlavorSupported in interface java.awt.datatransfer.Transferable
  - getTransferData
```
public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
                                 throws java.awt.datatransfer.UnsupportedFlavorException,
                                        java.io.IOException
```
    If the data was requested in the "java.lang.String" flavor, return the String representing the selection.
    
    Specified by:
    
    getTransferData in interface java.awt.datatransfer.Transferable
    
    Throws:
    
    java.awt.datatransfer.UnsupportedFlavorException
    
    java.io.IOException
  - getMissingValueCode
```
public java.util.Vector getMissingValueCode()
```
    Method to return the vector which store the missing value code. If this attribute doesn't has the missing value code, empty vector will be returned.
    
    Specified by:
    
    getMissingValueCode in interface DSTableFieldIFace
  - addMissingValueCode
```
public void addMissingValueCode(java.lang.String code)
```
    Method to add missing value code into a vector. This method will be used to store the missing value code in metadata
    
    Specified by:
    
    addMissingValueCode in interface DSTableFieldIFace
    
    Parameters:
    
    code -
  - setMissingValueCode
```
public void setMissingValueCode(java.util.Vector missingValueVector)
```
    Method to return the vector which store the missing value code. If this attribute doesn't has the missing value code, empty vector will be returned.
    
    Specified by:
    
    setMissingValueCode in interface DSTableFieldIFace

Class DBTableField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mTableField

mTableFrame

mRect

mIsLinked

mIsDragOver

mIsDisplayed

mPreferredDim

mMissingValueCode

flavors

Constructor Detail

DBTableField

DBTableField

Method Detail

getTableKeyIFace

getTable

setLinked

getLinked

setDisplayed

isDisplayed

getName

getTableName

getDataType

setDragOver

isDragOver

toString

getBounds

setRect

setRect

add

setPreferredDim

getPreferredDim

getTransferDataFlavors

isDataFlavorSupported

getTransferData

getMissingValueCode

addMissingValueCode

setMissingValueCode