oracle.odi.domain.model

Class OdiDataStore.FileDescriptor

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.PersistableValue

oracle.odi.domain.model.OdiDataStore.FileDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IModelObject, IModelObjectBase, IFileDescriptor

Enclosing class:

OdiDataStore

public static class OdiDataStore.FileDescriptor
extends oracle.odi.domain.support.PersistableValue
implements IFileDescriptor

A FileDescriptor holds the OdiDataStore configuration specific to datastore defined on a FILE OdiTechnology.

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiDataStore.FileDescriptor.Format Defines the type of file that the datastore represents.

Constructor Summary

Constructors

Constructor and Description
FileDescriptor(OdiDataStore.FileDescriptor.Format pFormat, java.lang.String pFieldSeparator, java.lang.String pTextDelimiter, java.lang.String pRowSeparator, int pSkipHeadingLines, java.lang.String pDecimalSeparator) Create a FileDescriptor.

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getBigNumericId() Gets a numeric id for this object, for repositories that support numeric id.
java.lang.String	getDecimalSeparator() Character separating the integer and decimal part of a NUMERIC character.
java.lang.String	getFieldSeparator() Returns the field separator.
OdiDataStore.FileDescriptor.Format	getFormat() Returns the OdiDataStore.FileDescriptor.Format for this file datastore.
java.lang.String	getFormatString() Returns the format (fixed or delimited) for this file datastore.
java.lang.String	getGlobalId() Gets the global id of this object, which should be unique across the repository.
java.lang.String	getName() Gets the name of this model object.
java.lang.Integer	getNumericId() Deprecated.
java.lang.String	getRowSeparator() Returns the record/row separator.
int	getSkipHeadingLines() Returns the number of record at the beginning of the file that are not data.
java.lang.String	getTextDelimiter() Returns the pair of characters delimiting a field.

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileDescriptor

public FileDescriptor(OdiDataStore.FileDescriptor.Format pFormat,
                      java.lang.String pFieldSeparator,
                      java.lang.String pTextDelimiter,
                      java.lang.String pRowSeparator,
                      int pSkipHeadingLines,
                      java.lang.String pDecimalSeparator)

Create a FileDescriptor.

Parameters:

pFormat - Format of the file

pFieldSeparator - Field Separator for Format.DELIMITED File

pTextDelimiter - Text delimiter

pRowSeparator - Row separator

pSkipHeadingLines - Number of lines to skip when reading the file

pDecimalSeparator - Decimal separator

Method Detail

getDecimalSeparator

public java.lang.String getDecimalSeparator()

Character separating the integer and decimal part of a NUMERIC character.

Specified by:

getDecimalSeparator in interface IFileDescriptor

Returns:

the decimal separator

getFieldSeparator

public java.lang.String getFieldSeparator()

Returns the field separator.

One ore several characters separating the fields in a record. The unicode representation of character should be used: \\uxxxx..

Specified by:

getFieldSeparator in interface IFileDescriptor

Returns:

the field separator.

getFormat

public OdiDataStore.FileDescriptor.Format getFormat()

Returns the OdiDataStore.FileDescriptor.Format for this file datastore.

Returns:

the file format.

getRowSeparator

public java.lang.String getRowSeparator()

Returns the record/row separator.

One or several characters separating records in the file. The unicode representation of character should be used: \\uxxxx.

Specified by:

getRowSeparator in interface IFileDescriptor

Returns:

the row separator

getSkipHeadingLines

public int getSkipHeadingLines()

Returns the number of record at the beginning of the file that are not data.

These lines are ignored.

Specified by:

getSkipHeadingLines in interface IFileDescriptor

Returns:

the number of lines to skip.

getTextDelimiter

public java.lang.String getTextDelimiter()

Returns the pair of characters delimiting a field.

This delimiter escapes the field and record separators. If a separator is in a field - between the delimiters - it is not taken into account. The two left and right delimiter characters may be similar or different.

Specified by:

getTextDelimiter in interface IFileDescriptor

Returns:

the text delimiters.

getName

public java.lang.String getName()

Description copied from interface: IModelObject

Gets the name of this model object.

Specified by:

getName in interface IModelObject

Returns:

name of this object

getFormatString

public java.lang.String getFormatString()

Description copied from interface: IFileDescriptor

Returns the format (fixed or delimited) for this file datastore.

Specified by:

getFormatString in interface IFileDescriptor

Returns:

the file format text

getGlobalId

public java.lang.String getGlobalId()

Description copied from interface: IModelObjectBase

Gets the global id of this object, which should be unique across the repository. The global id, or GUID, is used as the primary way to look up references to the model object.

Specified by:

getGlobalId in interface IModelObjectBase

Returns:

global id of this object

getNumericId

@Deprecated
public java.lang.Integer getNumericId()

Deprecated.

Specified by:

getNumericId in interface IModelObjectBase

Returns:

numeric id or null if it is not supported.

getBigNumericId

public java.lang.Number getBigNumericId()

Description copied from interface: IModelObjectBase

Gets a numeric id for this object, for repositories that support numeric id. Otherwise returns null.

Specified by:

getBigNumericId in interface IModelObjectBase

Returns:

numeric id or null if it is not supported.