|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The FlatFile
interface exposes the metadata for a logical flat file. It may be used either as a source or target in mapping, or as the basis of an ExternalTable.
Field Summary |
Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable |
MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH |
Method Summary | |
Record |
createRecord(java.lang.String name) Creates a new Record and adds it to the FlatFile. |
void |
deleteRecord(Record record) Deletes a Record of the FlatFile. |
Record |
findRecord(java.lang.String name) Finds a Record in the FlatFile. |
java.lang.String |
getCharacterset() Gets the character set of the FlatFile |
java.lang.String |
getContinueIfEndsWith() For datafiles containing logical records which themselves contain a variable number of fixed records. |
java.lang.String |
getContinueIfStartsWith() For datafiles containing logical records which themselves contain a variable number of fixed records. |
java.lang.String |
getFieldDelimiter() Gets the field delimiter of the FlatFile |
char |
getFieldLeftEnclosure() Gets the left enclosure character of a FlatFile whose fields are delimited. |
char |
getFieldRightEnclosure() Gets the right enclosure character of a FlatFile whose fields are delimited. |
int |
getNumberOfPhysicalPerLogicalRecord() Gets the number of physical records in the datafile which will be concatenated to form a single logical record. |
int |
getNumberOfRecordsToSkip() Gets the default number of records to skip when loading this FlatFile. |
FlatFileModule |
getOwningFlatFileModule() Gets the owning FlatFileModule of this FlatFile. |
java.lang.String |
getRecordDelimiter() Sets the String which is the FlatFile's record delimiter. |
int |
getRecordLength() Gets the record length of the FlatFile. |
Record[] |
getRecords() Gets all of the records of this FlatFile. |
int |
getRecordTypeColumnNumber() Gets the record type column number for a multi-record FlatFile whose fields are delimited. |
int |
getRecordTypeEndPosition() Gets the end position of the record type value for a multi-record FlatFile whose fields are of fixed lengths. |
int |
getRecordTypeStartPosition() Gets the start position of the record type for a multi-record FlatFile whose fields are of fixed lengths. |
java.lang.String |
getSourceFrom() Gets the default data file that this FlatFile object is sourced from. |
boolean |
isDelimited() Gets the FlatFile format. |
void |
setCharacterset(java.lang.String characterset) Sets the character set of the FlatFile. |
void |
setContinueIfEndsWith(java.lang.String continueChar) For datafiles containing logical records which themselves contain a variable number of fixed records. |
void |
setContinueIfStartsWith(java.lang.String continueChar) For datafiles containing logical records which themselves contain a variable number of fixed records. |
void |
setDelimitedFormat(boolean value) Sets the FlatFile format. |
void |
setFieldDelimiter(java.lang.String delimiter) Sets the field delimiter of the FlatFile to the specified String |
void |
setFieldLeftEnclosure(char enclosureChar) Sets the left enclosure character of a FlatFile whose fields are delimited. |
void |
setFieldRightEnclosure(char enclosureChar) Sets the right enclosure character of a FlatFile whose fields are delimited. |
void |
setNumberOfPhysicalPerLogicalRecord(int number) Sets the number of physical records in the datafile which will be concatenated to form a single logical record. |
void |
setNumberOfRecordsToSkip(int number) Sets the default number of records to skip when loading this FlatFile. |
void |
setRecordDelimiter(java.lang.String delimiter) Sets the String which is the FlatFile's record delimiter. |
void |
setRecordLength(int length) Sets the record length of the FlatFile. |
void |
setRecordTypeColumnNumber(int columnNumber) Sets the record type column number for a multi-record FlatFile whose fields are delimited. |
void |
setRecordTypeEndPosition(int endPosition) Sets the end position of the record type for a multi-record FlatFile whose fields are of fixed lengths. |
void |
setRecordTypeStartPosition(int startPosition) Sets the start position of the record type for a multi-record FlatFile whose fields are of fixed lengths. |
void |
setSourceFrom(java.lang.String sourcefrom) Sets the default data file that this FlatFile object is sourced from. |
Methods inherited from interface oracle.owb.foundation.Component |
getOwningFolder, isReloadNeeded, lock, reload, unlock |
Methods inherited from interface oracle.owb.foundation.OWBNamedObject |
delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName |
Methods inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable |
compare, compare, compare, compare, createSnapshot, createSnapshot, createSnapshotWithDependeeComponents, createSnapshotWithDependeeComponents, getSnapshots |
Methods inherited from interface oracle.owb.reconcile.ReconcileSource |
getReconcileTargetTypes, getType |
Methods inherited from interface oracle.owb.reconcile.ReconcileTarget |
canMatchByPosition, getReconcileSourceTypes, getType |
Methods inherited from interface oracle.owb.foundation.property.PropertyOwner |
getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString |
Methods inherited from interface oracle.owb.compile.ValidatableObject |
validate |
Method Detail |
public FlatFileModule getOwningFlatFileModule()
public Record createRecord(java.lang.String name) throws NameSpaceException, InvalidFormatException
name
- a String which will be the name of the new Record. The name will be converted to all uppercase characters if it is not already.NameSpaceException
- If the name has already been used by a Record in this FlatFileInvalidFormatException
- If the name is not a valid name for a Record. For example, it is too long or contains invalid characters.public void deleteRecord(Record record) throws NameSpaceException, InvalidFormatException
record
- a Record object which should be deleted be converted to all uppercase characters if it is not already.NameSpaceException
InvalidFormatException
public Record[] getRecords()
public Record findRecord(java.lang.String name)
name
- a String specifying the name of the Record to find. It is case sensitive.public void setDelimitedFormat(boolean value)
value
- if value is true the FlatFile contains delimitted Records if value is false the FlatFile contains fixed-length Recordspublic boolean isDelimited()
public void setSourceFrom(java.lang.String sourcefrom)
sourcefrom
- a String representing the file name of the default datafilegetSourceFrom
public java.lang.String getSourceFrom()
setSourceFrom
public void setCharacterset(java.lang.String characterset)
characterset
- a String which is the name of the datafile's charactersetgetCharacterset
public java.lang.String getCharacterset()
setCharacterset
public void setRecordDelimiter(java.lang.String delimiter)
delimiter
- the String delimiting the records of this FlatFilegetRecordDelimiter
public java.lang.String getRecordDelimiter()
setRecordDelimiter
public void setRecordLength(int length)
length
- the length of this FlatFile's records, in charactersgetRecordLength
public int getRecordLength()
setRecordLength
public void setRecordTypeColumnNumber(int columnNumber)
columnNumber
- specifies which column determines record typegetRecordTypeColumnNumber
public int getRecordTypeColumnNumber()
getRecordTypeColumnNumber
public void setRecordTypeStartPosition(int startPosition)
startPosition
- the position in the data record where the record type value beginsgetRecordTypeStartPosition
public int getRecordTypeStartPosition()
setRecordTypeStartPosition
public void setRecordTypeEndPosition(int endPosition)
endPosition
- the position in the data record where the record type value endsgetRecordTypeEndPosition
public int getRecordTypeEndPosition()
setRecordTypeEndPosition
public void setNumberOfRecordsToSkip(int number)
number
- the number of records to skipgetNumberOfRecordsToSkip
public int getNumberOfRecordsToSkip()
setNumberOfRecordsToSkip
public void setFieldDelimiter(java.lang.String delimiter)
delimiter
- the String delimiting the fields of this FlatFile.getFieldDelimiter
public java.lang.String getFieldDelimiter()
setFieldDelimiter
public void setFieldLeftEnclosure(char enclosureChar)
enclosureChar
- the character enclosing the fields of this FlatFilegetFieldLeftEnclosure
public char getFieldLeftEnclosure()
setFieldLeftEnclosure
public void setFieldRightEnclosure(char enclosureChar)
enclosureChar
- the character enclosing the fields of this FlatFilegetFieldRightEnclosure
public char getFieldRightEnclosure()
setFieldRightEnclosure
public void setNumberOfPhysicalPerLogicalRecord(int number)
number
- the number of physical records in each logical recordgetNumberOfPhysicalPerLogicalRecord
public int getNumberOfPhysicalPerLogicalRecord()
setNumberOfPhysicalPerLogicalRecord
public void setContinueIfEndsWith(java.lang.String continueChar)
continueChar
- the character to test the last nonblank character againstgetContinueIfEndsWith
public java.lang.String getContinueIfEndsWith()
setContinueIfEndsWith
public void setContinueIfStartsWith(java.lang.String continueChar)
continueChar
- the String to compare to the begining of the next physical recordgetContinueIfStartsWith
public java.lang.String getContinueIfStartsWith()
setContinueIfStartsWith
|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |