| java.lang.Object
 net.sourceforge.squirrel_sql.fw.datasetviewer.cellcomponent.BaseDataTypeComponent
net.sourceforge.squirrel_sql.fw.datasetviewer.cellcomponent.DataTypeJavaObject
| DataTypeJavaObject | | public class DataTypeJavaObject extends BaseDataTypeComponent implements IDataTypeComponent(Code) | |
author:
gwg
author:
This class provides the display components for handling SQL JAVA_OBJECT data types,
author:
specifically SQL type JAVA_OBJECT.
author:
author:
The default SQuirreL code can handle only JDBC-standard defined data types.
author:
Since this data type represents DBMS-specific enhancements or
author:
user-defined data types, we cannot do anything intelligent with the data.
author:
We allow the user to select one of two modes of operation:
author:
author:
author:
we can try to get the contents of the DB element and print it as a string, or,
author:
author:
we will display an appropriately internationalized version of "".
author:
author:
In either case, the data will be stored and processed as a String.
author:
author:
The user may not edit the contents of this field in either the cell or popup
author:
because we do not understand the structure or limitations of the contents,
author:
and therefore cannot validate it or put it back into the DB.
author:
The field is not used in the WHERE clause because we do not know whether
author:
or not it might contain binary data, and because we do not know how to
author:
format the data for SQL operations.
author:
author:
To handle these data types more intelligently and allow editing on them,
author:
DBMS-specific plug-ins will need to be developed to register handlers
author:
for instances of this type.
|
| Method Summary | |
| public boolean | areEqual(Object obj1, Object obj2)
Determine if two objects of this data type contain the same value. | | public boolean | canDoFileIO()
Say whether or not object can be exported to and imported from
a file. | | public void | exportObject(FileOutputStream outStream, String text)
Construct an appropriate external representation of the object
and write it to a file.
Errors are returned by throwing an IOException containing the
cause of the problem as its message.
DataType is responsible for validating that the given text
text from a Popup JTextArea can be converted to an object.
This text-to-object conversion is the same as validateAndConvertInPopup,
which may be used internally by the object to do the validation.
The DataType object must flush and close the output stream before returning.
Typically it will create another object (e.g. | | public String | getClassName()
Return the name of the java class used to hold this data type. | | public static OkJPanel | getControlPanel()
Generate a JPanel containing controls that allow the user
to adjust the properties for this DataType. | | public Object | getDefaultValue(String dbDefaultValue)
Get a default value for the table used to input data for a new row
to be inserted into the DB. | | public JTextArea | getJTextArea(Object value)
| | public JTextField | getJTextField()
Return a JTextField usable in a CellEditor. | | public String | getWhereClauseValue(Object value, ISQLDatabaseMetaData md)
When updating the database, generate a string form of this object value
that can be used in the WHERE clause to match the value in the database. | | public String | importObject(FileInputStream inStream)
Read a file and construct a valid object from its contents. | | public boolean | isEditableInCell(Object originalValue)
This Data Type can be edited in a table cell. | | public boolean | isEditableInPopup(Object originalValue)
Returns true if data type may be edited in the popup,
false if not. | | public boolean | needToReRead(Object originalValue)
See if a value in a column has been limited in some way and
needs to be re-read before being used for editing. | | public Object | readResultSet(ResultSet rs, int index, boolean limitDataRead)
On input from the DB, read the data from the ResultSet into the appropriate
type of object to be stored in the table cell. | | public String | renderObject(Object value)
Render a value into text for this DataType. | | public void | setPreparedStatementValue(PreparedStatement pstmt, Object value, int position)
When updating the database, insert the appropriate datatype into the
prepared statment at the given variable position. | | public boolean | useBinaryEditingPanel()
If true, this tells the PopupEditableIOPanel to use the
binary editing panel rather than a pure text panel.
The binary editing panel assumes the data is an array of bytes,
converts it into text form, allows the user to change how that
data is displayed (e.g. | | public Object | validateAndConvert(String value, Object originalValue, StringBuffer messageBuffer)
Implement the interface for validating and converting to internal object. | | public Object | validateAndConvertInPopup(String value, Object originalValue, StringBuffer messageBuffer)
Validating and converting in Popup is identical to cell-related operation. |
| areEqual | | public boolean areEqual(Object obj1, Object obj2)(Code) | | Determine if two objects of this data type contain the same value.
Neither of the objects is null
|
| canDoFileIO | | public boolean canDoFileIO()(Code) | | Say whether or not object can be exported to and imported from
a file. We put both export and import together in one test
on the assumption that all conversions can be done both ways.
|
| exportObject | | public void exportObject(FileOutputStream outStream, String text) throws IOException(Code) | | Construct an appropriate external representation of the object
and write it to a file.
Errors are returned by throwing an IOException containing the
cause of the problem as its message.
DataType is responsible for validating that the given text
text from a Popup JTextArea can be converted to an object.
This text-to-object conversion is the same as validateAndConvertInPopup,
which may be used internally by the object to do the validation.
The DataType object must flush and close the output stream before returning.
Typically it will create another object (e.g. an OutputWriter), and
that is the object that must be flushed and closed.
File is assumed to be printable text characters,
possibly including newlines and tabs but not characters
that would require a binary representation to display
to user.
|
| getClassName | | public String getClassName()(Code) | | Return the name of the java class used to hold this data type.
For JavaObject, this will always be a string.
|
| getControlPanel | | public static OkJPanel getControlPanel()(Code) | | Generate a JPanel containing controls that allow the user
to adjust the properties for this DataType.
All properties are static accross all instances of this DataType.
However, the class may choose to apply the information differentially,
such as keeping a list (also entered by the user) of table/column names
for which certain properties should be used.
This is called ONLY if there is at least one property entered into the DTProperties
for this class.
Since this method is called by reflection on the Method object derived from this class,
it does not need to be included in the Interface.
It would be nice to include this in the Interface for consistancy, documentation, etc,
but the Interface does not seem to like static methods.
|
| getDefaultValue | | public Object getDefaultValue(String dbDefaultValue)(Code) | | Get a default value for the table used to input data for a new row
to be inserted into the DB.
|
| getJTextField | | public JTextField getJTextField()(Code) | | Return a JTextField usable in a CellEditor.
|
| getWhereClauseValue | | public String getWhereClauseValue(Object value, ISQLDatabaseMetaData md)(Code) | | When updating the database, generate a string form of this object value
that can be used in the WHERE clause to match the value in the database.
A return value of null means that this column cannot be used in the WHERE
clause, while a return of "null" (or "is null", etc) means that the column
can be used in the WHERE clause and the value is actually a null value.
This function must also include the column label so that its output
is of the form:
"columnName = value"
or
"columnName is null"
or whatever is appropriate for this column in the database.
|
| importObject | | public String importObject(FileInputStream inStream) throws IOException(Code) | | Read a file and construct a valid object from its contents.
Errors are returned by throwing an IOException containing the
cause of the problem as its message.
DataType is responsible for validating that the imported
data can be converted to an object, and then must return
a text string that can be used in the Popup window text area.
This object-to-text conversion is the same as is done by
the DataType object internally in the getJTextArea() method.
File is assumed to be printable text characters,
possibly including newlines and tabs but not characters
that would require a binary representation to display
to user.
|
| isEditableInCell | | public boolean isEditableInCell(Object originalValue)(Code) | | This Data Type can be edited in a table cell.
|
| isEditableInPopup | | public boolean isEditableInPopup(Object originalValue)(Code) | | Returns true if data type may be edited in the popup,
false if not.
|
| needToReRead | | public boolean needToReRead(Object originalValue)(Code) | | See if a value in a column has been limited in some way and
needs to be re-read before being used for editing.
For read-only tables this may actually return true since we want
to be able to view the entire contents of the cell even if it was not
completely loaded during the initial table setup.
|
| readResultSet | | public Object readResultSet(ResultSet rs, int index, boolean limitDataRead) throws java.sql.SQLException(Code) | | On input from the DB, read the data from the ResultSet into the appropriate
type of object to be stored in the table cell.
|
| renderObject | | public String renderObject(Object value)(Code) | | Render a value into text for this DataType.
|
| setPreparedStatementValue | | public void setPreparedStatementValue(PreparedStatement pstmt, Object value, int position) throws java.sql.SQLException(Code) | | When updating the database, insert the appropriate datatype into the
prepared statment at the given variable position.
|
| useBinaryEditingPanel | | public boolean useBinaryEditingPanel()(Code) | | If true, this tells the PopupEditableIOPanel to use the
binary editing panel rather than a pure text panel.
The binary editing panel assumes the data is an array of bytes,
converts it into text form, allows the user to change how that
data is displayed (e.g. Hex, Decimal, etc.), and converts
the data back from text to bytes when the user editing is completed.
If this returns false, this DataType class must
convert the internal data into a text string that
can be displayed (and edited, if allowed) in a TextField
or TextArea, and must handle all
user key strokes related to editing of that data.
|
| validateAndConvert | | public Object validateAndConvert(String value, Object originalValue, StringBuffer messageBuffer)(Code) | | Implement the interface for validating and converting to internal object.
Since we do not know how to convert JavaObject objects,
just return null with no error in the messageBuffer
|
| validateAndConvertInPopup | | public Object validateAndConvertInPopup(String value, Object originalValue, StringBuffer messageBuffer)(Code) | | Validating and converting in Popup is identical to cell-related operation.
|
|
|