| org.netbeans.modules.mashup.db.model.FlatfileDBTable
All known Subclasses: org.netbeans.modules.mashup.db.model.impl.FlatfileDBTableImpl,
| FlatfileDBTable | | public interface FlatfileDBTable extends SQLDBTable(Code) | | Extends DBTable to support metadata and behavior of a flatfile as an analogue for a
database table.
author:
Jonathan Giron
author:
Ahimanikya Satapathy
version:
$Revision$ |
| Method Summary | |
| Object | clone()
Clone a deep copy of DBTable. | | int | compareTo(Object refObj)
Compares DBTable with another object for lexicographical ordering. | | void | copyFrom(FlatfileDBTable source)
Performs deep copy of contents of given FlatfileDBTable. | | FlatfileDBColumn | createColumn(String columnName, int jdbcType, int scale, int precision, boolean isPK, boolean isFK, boolean isIndexed, boolean nullable)
Convenience class to create FlatfileDBColumnImpl instance (with the given column
name, data source name, JDBC type, scale, precision, and nullable), and add it to
this FlatfileDBTableImpl instance. | | boolean | equals(Object obj)
Overrides default implementation to return value based on memberwise comparison. | | String | getCreateStatementSQL()
| | String | getCreateStatementSQL(String directory, String theTableName, String runtimeName, boolean isDynamicFilePath, boolean createDataFileIfNotExist)
Gets the SQL create statement to create a text table representing this flatfile. | | String | getDropStatementSQL()
| | String | getEncodingScheme()
Gets the encoding scheme. | | String | getFileName()
| | String | getFlatfilePropertiesSQL()
| | String | getLocalFilePath()
Gets local path to sample file. | | String | getParserType()
| | Map | getProperties()
| | String | getProperty(String key)
Gets property string associated with the given name. | | String | getSelectStatementSQL(int rows)
| | String | getTableName()
Gets the table name. | | int | hashCode()
Overrides default implementation to compute hashCode value for those members used
in equals() for comparison. | | void | setDescription(String newDesc)
Sets description text for this instance. | | void | setEncodingScheme(String newEncoding)
Sets the encoding scheme. | | void | setFileName(String newName)
Sets the file name. | | void | setLocalFilePath(File localFile)
Sets local path to sample file.
Parameters:
localFile - File representing path to sample file. | | void | setParseType(String type)
| | void | setProperties(Map newProps)
| | boolean | setProperty(String key, Object value)
| | String | toString()
Overrides default implementation to return fully-qualified name of this DBTable
(including name of parent DatabaseModel). | | void | updateProperties(Map newProps)
|
| PROP_CREATE_IF_NOT_EXIST | | final public static String PROP_CREATE_IF_NOT_EXIST(Code) | | |
| clone | | Object clone()(Code) | | Clone a deep copy of DBTable.
a copy of DBTable. |
| compareTo | | int compareTo(Object refObj)(Code) | | Compares DBTable with another object for lexicographical ordering. Null objects and
those DBTables with null names are placed at the end of any ordered collection
using this method.
Parameters:
refObj - Object to be compared. -1 if the column name is less than obj to be compared. 0 if the column nameis the same. 1 if the column name is greater than obj to be compared. |
| copyFrom | | void copyFrom(FlatfileDBTable source)(Code) | | Performs deep copy of contents of given FlatfileDBTable. We deep copy (that is, the
method clones all child objects such as columns) because columns have a
parent-child relationship that must be preserved internally.
Parameters:
source - FlatfileDBTable providing contents to be copied. |
| createColumn | | FlatfileDBColumn createColumn(String columnName, int jdbcType, int scale, int precision, boolean isPK, boolean isFK, boolean isIndexed, boolean nullable)(Code) | | Convenience class to create FlatfileDBColumnImpl instance (with the given column
name, data source name, JDBC type, scale, precision, and nullable), and add it to
this FlatfileDBTableImpl instance.
Parameters:
columnName - Column name
Parameters:
jdbcType - JDBC type defined in SQL.Types
Parameters:
scale - Scale
Parameters:
precision - Precision
Parameters:
isPK - true if part of primary key, false otherwise
Parameters:
isFK - true if part of foreign key, false otherwise
Parameters:
isIndexed - true if indexed, false otherwise
Parameters:
nullable - Nullable new FlatfileDBColumnImpl instance |
| equals | | boolean equals(Object obj)(Code) | | Overrides default implementation to return value based on memberwise comparison.
Parameters:
obj - Object against which we compare this instance true if obj is functionally identical to this ETLTable instance; falseotherwise |
| getCreateStatementSQL | | String getCreateStatementSQL()(Code) | | Gets the Create Statement SQL for creating table for a flat file
SQL for this Flatfile with getTableName() |
| getCreateStatementSQL | | String getCreateStatementSQL(String directory, String theTableName, String runtimeName, boolean isDynamicFilePath, boolean createDataFileIfNotExist)(Code) | | Gets the SQL create statement to create a text table representing this flatfile.
SQL statement to create a text table representing the contents of thisflatfile |
| getEncodingScheme | | String getEncodingScheme()(Code) | | Gets the encoding scheme.
encoding scheme |
| getFlatfilePropertiesSQL | | String getFlatfilePropertiesSQL()(Code) | | |
| getLocalFilePath | | String getLocalFilePath()(Code) | | Gets local path to sample file.
path (in local workstation file system) to file, excluding the filename. |
| getProperty | | String getProperty(String key)(Code) | | Gets property string associated with the given name.
Parameters:
key - property key property associated with propName, or null if no such property exists. |
| getSelectStatementSQL | | String getSelectStatementSQL(int rows)(Code) | | |
| getTableName | | String getTableName()(Code) | | Gets the table name.
Table name |
| hashCode | | int hashCode()(Code) | | Overrides default implementation to compute hashCode value for those members used
in equals() for comparison.
hash code for this object
See Also: java.lang.Object.hashCode |
| setDescription | | void setDescription(String newDesc)(Code) | | Sets description text for this instance.
Parameters:
newDesc - new descriptive text |
| setEncodingScheme | | void setEncodingScheme(String newEncoding)(Code) | | Sets the encoding scheme.
Parameters:
newEncoding - encoding scheme |
| setFileName | | void setFileName(String newName)(Code) | | Sets the file name.
Parameters:
newName - new file name |
| setLocalFilePath | | void setLocalFilePath(File localFile)(Code) | | Sets local path to sample file.
Parameters:
localFile - File representing path to sample file. If localFile represents thefile itself, only the directory path will be stored. |
| setProperties | | void setProperties(Map newProps)(Code) | | |
| toString | | String toString()(Code) | | Overrides default implementation to return fully-qualified name of this DBTable
(including name of parent DatabaseModel).
table name. |
| updateProperties | | void updateProperties(Map newProps)(Code) | | |
|
|