| java.lang.Object
 org.netbeans.modules.mashup.db.ui.model.FlatfileTable
All known Subclasses: org.netbeans.modules.mashup.db.ui.model.DelimitedFlatfile, org.netbeans.modules.mashup.db.ui.model.FixedWidthFlatfile,
| FlatfileTable | | abstract public class FlatfileTable (Code) | | Abstract bean wrapper for FlatfileDBTable instances to expose common read-only
properties for display in a Flatfile Database definition property sheet.
author:
Jonathan Giron
version:
$Revision$ |
| Constructor Summary | |
| protected | FlatfileTable(FlatfileDBTable dbTable)
Creates new instance of FlatfileTable, wrapping the given FlatfileDBTable instance. |
| Method Summary | |
| public boolean | enableWhiteSpaceTrimming()
| | public String | getCatalog()
Gets catalog, if any, with which the table is associated. | | public DBColumn | getColumn(String name)
Gets column, if any, with the given name. | | public List | getColumnList()
Gets List of columns contained by this instance. | | public String | getDescription()
Gets optional description of this table. | | public String | getEncodingScheme()
| | public String | getFileName()
Gets file name. | | public String | getFileType()
| | public ForeignKey | getForeignKey(String keyName)
Gets ForeignKey instance, if any, with the given name and associated with this
table. | | public List | getForeignKeys()
Gets List, possibly empty, of foreign keys associated with this table. | | public Index | getIndex(String name)
Gets Index instance, if any, associated with the given name. | | public List | getIndexes()
Gets List, possibly empty, of Indexes associated with this table. | | public Integer | getMaxFaults()
Gets threshold number of faults, above which further parsing/execution should be
halted. | | public String | getName()
Gets name of this instance - ordinarily the same as getTableName(). | | public PrimaryKey | getPrimaryKey()
Gets PrimaryKey instance, if any, associated with this table. | | public String | getProperty(String propName)
Gets property string associated with the given name. | | public String | getRecordDelimiter()
Gets the character(s) used to delimit records in this file. | | public Integer | getRowsToSkip()
| | public String | getSchema()
Gets schema, if any, with which the table is associated. | | public String | getSelectStatementSQL(int rows)
Gets the SQL select statement to retrieve a result set displaying this file's
contents, using the given value as a limit to the number of rows returned. | | final public FlatfileDBTable | getSource()
Gets instance of FlatfileDBTble wrapped by this object. | | public String | getTableName()
Gets table name associated with this flatfile. | | public boolean | isFirstLineHeader()
Indicates whether the first physical record of the flatfile contains field header
information. |
| FlatfileTable | | protected FlatfileTable(FlatfileDBTable dbTable)(Code) | | Creates new instance of FlatfileTable, wrapping the given FlatfileDBTable instance.
Parameters:
dbTable - FlatfileDBTable instance (delimited type) to be wrapped. |
| enableWhiteSpaceTrimming | | public boolean enableWhiteSpaceTrimming()(Code) | | Indicates whether white space trimming is enabled or not
|
| getCatalog | | public String getCatalog()(Code) | | Gets catalog, if any, with which the table is associated.
name of associated catalog; may return "" if value is null or emptystring |
| getColumn | | public DBColumn getColumn(String name)(Code) | | Gets column, if any, with the given name.
Parameters:
name - name of column to get DBColumn associated with name, or null if no such columnexists |
| getColumnList | | public List getColumnList()(Code) | | Gets List of columns contained by this instance.
List of FlatfileDBColumns that are part of this instance |
| getDescription | | public String getDescription()(Code) | | Gets optional description of this table.
table description string |
| getEncodingScheme | | public String getEncodingScheme()(Code) | | Gets name of encoding scheme to use in parsing underlying flatfile data
current encoding scheme |
| getFileName | | public String getFileName()(Code) | | Gets file name.
file name |
| getFileType | | public String getFileType()(Code) | | Gets the current file type - Delimited or FixedWidth
String representing current file type, one of 'Delimited' or 'FixedWidth' |
| getForeignKey | | public ForeignKey getForeignKey(String keyName)(Code) | | Gets ForeignKey instance, if any, with the given name and associated with this
table.
ForeignKey instance, or null if no such key exists with the namekeyname |
| getForeignKeys | | public List getForeignKeys()(Code) | | Gets List, possibly empty, of foreign keys associated with this table.
List, possibly empty, of associated foreign keys |
| getIndex | | public Index getIndex(String name)(Code) | | Gets Index instance, if any, associated with the given name.
Parameters:
name - name of index to get Index instance, or null if no such Index exists with the namename |
| getIndexes | | public List getIndexes()(Code) | | Gets List, possibly empty, of Indexes associated with this table.
List, possibly empty, of assocaited Index objects |
| getMaxFaults | | public Integer getMaxFaults()(Code) | | Gets threshold number of faults, above which further parsing/execution should be
halted.
Integer representing maximum number of parsing faults to tolerate beforeraising an exception. |
| getPrimaryKey | | public PrimaryKey getPrimaryKey()(Code) | | Gets PrimaryKey instance, if any, associated with this table.
PrimaryKey instance, or null if no PK exists |
| getProperty | | public String getProperty(String propName)(Code) | | Gets property string associated with the given name.
Parameters:
propName - property key property associated with propName, or null if no such property exists. |
| getRecordDelimiter | | public String getRecordDelimiter()(Code) | | Gets the character(s) used to delimit records in this file.
record delimiter string |
| getRowsToSkip | | public Integer getRowsToSkip()(Code) | | Gets number of rows to skip as header information (non-data)
Integer representing rows to skip |
| getSchema | | public String getSchema()(Code) | | Gets schema, if any, with which the table is associated.
name of associated schema; may return "" if value is null or emptystring |
| getSelectStatementSQL | | public String getSelectStatementSQL(int rows)(Code) | | Gets the SQL select statement to retrieve a result set displaying this file's
contents, using the given value as a limit to the number of rows returned.
Parameters:
rowCount - number of rows to display; 0 returns all available rows SQL statement to select the contents of this file in the column orderspecified by this instance's FlatfileFields. |
| getSource | | final public FlatfileDBTable getSource()(Code) | | Gets instance of FlatfileDBTble wrapped by this object.
FlatfileDBTable associated with this instance |
| getTableName | | public String getTableName()(Code) | | Gets table name associated with this flatfile.
table name |
| isFirstLineHeader | | public boolean isFirstLineHeader()(Code) | | Indicates whether the first physical record of the flatfile contains field header
information.
true if first physical record contains field header information; falseotherwise |
|
|