oracle.odi.domain.model

Class OdiColumn.FileDescriptor

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.PersistableValue

oracle.odi.domain.model.OdiColumn.FileDescriptor

All Implemented Interfaces:

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

Enclosing class:

OdiColumn

public static class OdiColumn.FileDescriptor
extends oracle.odi.domain.support.PersistableValue
implements IFileFieldDescriptor

Defines OdiColumn properties that are specific to OdiColumns on FILE technologies.

Since:

11.1.1.3.0

See Also:

OdiColumn.setFileDescriptor(oracle.odi.domain.model.OdiColumn.FileDescriptor), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiColumn.FileDescriptor.OnErrorOption Defines the possible action in that can be taken during file loading if when the actual content of the file does not match the column definition.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DECIMAL_SEPARATOR_MAX_LENGTH Maximum length supported for the "decimalSeparator" property.

Constructor Summary

Constructors

Constructor and Description
FileDescriptor() Creates a new OdiColumn.FileDescriptor.
FileDescriptor(java.lang.Integer pStartPosition, int pBytes, java.lang.String pLogicalFormat, java.lang.String[] pRecordCodes, boolean pExcludeRecordCodes, java.lang.String pDecimalSeparator, OdiColumn.FileDescriptor.OnErrorOption pOnErrorOption) Creates a new OdiColumn.FileDescriptor.
FileDescriptor(java.lang.Integer pStartPosition, int pBytes, java.lang.String pLogicalFormat, java.lang.String pRecordCodes, java.lang.String pDecimalSeparator, OdiColumn.FileDescriptor.OnErrorOption pOnErrorOption) Deprecated.

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.
int	getBytes() Returns the physical length in bytes.
java.lang.String	getDecimalSeparator() Returns the decimal separator.
java.lang.String	getGlobalId() Gets the global id of this object, which should be unique across the repository.
java.lang.String	getLogicalFormat() Returns the format used to parse date.
java.lang.String	getName() Gets the name of this model object.
java.lang.Integer	getNumericId() Deprecated.
OdiColumn.FileDescriptor.OnErrorOption	getOnErrorOption() Returns the OdiColumn.FileDescriptor.OnErrorOption for this column.
java.lang.String	getOnErrorOptionString() Returns the OnError option for this field.
java.lang.String[]	getRecordCodeList() Returns the record codes.
java.lang.String	getRecordCodes() Deprecated. replaced by getRecordCodeList()
java.lang.Integer	getStartPosition() Returns the start position of the column in the row.
boolean	isRecordCodesExcluded() Returns true if the rows respecting the record codes will be excluded instead of being included when loading the file.
void	setBytes(int pBytes) Sets the physical length in bytes.
void	setDecimalSeparator(java.lang.String pDecimalSeparator) Sets the separator used for decimal parsing.
void	setLogicalFormat(java.lang.String pLogicalFormat) Sets the format used for date parsing.
void	setOnErrorOption(OdiColumn.FileDescriptor.OnErrorOption pOnErrorOption) Sets the OdiColumn.FileDescriptor.OnErrorOption for this column.
void	setRecordCodeList(java.lang.String[] pRecordCodeList) Sets the record codes.
void	setRecordCodes(java.lang.String pRecordCodes) Deprecated. replaced by setRecordCodeList(String[] pRecordCodeList)
void	setRecordCodesExcluded(boolean pExcludeRecordCodes) Sets if the rows respecting the record codes will be excluded instead of being included when loading the file.
void	setStartPosition(java.lang.Integer pStartPosition) Sets the start position of the column in the row.

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

Field Detail

DECIMAL_SEPARATOR_MAX_LENGTH

public static final int DECIMAL_SEPARATOR_MAX_LENGTH

Maximum length supported for the "decimalSeparator" property.

See Also:

setDecimalSeparator(String), Constant Field Values

Constructor Detail

FileDescriptor

public FileDescriptor()

Creates a new OdiColumn.FileDescriptor.

FileDescriptor

@Deprecated
public FileDescriptor(java.lang.Integer pStartPosition,
                                  int pBytes,
                                  java.lang.String pLogicalFormat,
                                  java.lang.String pRecordCodes,
                                  java.lang.String pDecimalSeparator,
                                  OdiColumn.FileDescriptor.OnErrorOption pOnErrorOption)

Deprecated.

Creates a new OdiColumn.FileDescriptor.

Parameters:

pStartPosition - the start position from the beginning of the row.

pBytes - the physical length of the column in bytes.

pLogicalFormat - the logical format used for dates.

pRecordCodes - the list of record codes.

pDecimalSeparator - The decimal separator.

pOnErrorOption - The OnErrorOption

FileDescriptor

public FileDescriptor(java.lang.Integer pStartPosition,
                      int pBytes,
                      java.lang.String pLogicalFormat,
                      java.lang.String[] pRecordCodes,
                      boolean pExcludeRecordCodes,
                      java.lang.String pDecimalSeparator,
                      OdiColumn.FileDescriptor.OnErrorOption pOnErrorOption)

Creates a new OdiColumn.FileDescriptor.

Parameters:

pStartPosition - the start position from the beginning of the row.

pBytes - the physical length of the column in bytes.

pLogicalFormat - the logical format used for dates.

pRecordCodes - the array of record codes.

pExcludeRecordCodes - if true the rows respecting the record codes will be excluded instead of being included when loading the file

pDecimalSeparator - The decimal separator.

pOnErrorOption - The OnErrorOption

Method Detail

getBytes

public int getBytes()

Returns the physical length in bytes.

Specified by:

getBytes in interface IFileFieldDescriptor

Returns:

the physical length in bytes.

See Also:

setBytes(int)

getDecimalSeparator

public java.lang.String getDecimalSeparator()

Returns the decimal separator.

Specified by:

getDecimalSeparator in interface IFileFieldDescriptor

Returns:

the decimal separator.

See Also:

setDecimalSeparator(String)

getLogicalFormat

public java.lang.String getLogicalFormat()

Returns the format used to parse date.

Specified by:

getLogicalFormat in interface IFileFieldDescriptor

Returns:

the format.

See Also:

setLogicalFormat(String)

getOnErrorOption

public OdiColumn.FileDescriptor.OnErrorOption getOnErrorOption()

Returns the OdiColumn.FileDescriptor.OnErrorOption for this column.

Default value is OdiColumn.FileDescriptor.OnErrorOption.FAIL.

Returns:

the OdiColumn.FileDescriptor.OnErrorOption

See Also:

setOnErrorOption(OnErrorOption)

getRecordCodes

@Deprecated
public java.lang.String getRecordCodes()

Deprecated. replaced by getRecordCodeList()

Returns the record codes. See documentation for more information.

Returns:

the record codes.

See Also:

setRecordCodes(String)

getStartPosition

public java.lang.Integer getStartPosition()

Returns the start position of the column in the row.

Specified by:

getStartPosition in interface IFileFieldDescriptor

Returns:

the start position.

See Also:

setStartPosition(Integer)

setBytes

public void setBytes(int pBytes)

Sets the physical length in bytes.

Parameters:

pBytes - the physical length.

See Also:

getBytes()

setDecimalSeparator

public void setDecimalSeparator(java.lang.String pDecimalSeparator)

Sets the separator used for decimal parsing.

Parameters:

pDecimalSeparator - the decimal separator

Throws:

DomainRuntimeException - if pDecimalSeparator is longer than 1

See Also:

getDecimalSeparator()

setLogicalFormat

public void setLogicalFormat(java.lang.String pLogicalFormat)

Sets the format used for date parsing.

Parameters:

pLogicalFormat - the date format.

See Also:

getLogicalFormat()

setOnErrorOption

public void setOnErrorOption(OdiColumn.FileDescriptor.OnErrorOption pOnErrorOption)

Sets the OdiColumn.FileDescriptor.OnErrorOption for this column.

Parameters:

pOnErrorOption - the OdiColumn.FileDescriptor.OnErrorOption

See Also:

getOnErrorOption()

setRecordCodes

@Deprecated
public void setRecordCodes(java.lang.String pRecordCodes)

Deprecated. replaced by setRecordCodeList(String[] pRecordCodeList)

Sets the record codes.

Parameters:

pRecordCodes - the list of record codes separated by ";". The list have to be prefixed with $INC$ if the codes are included or by $EXC$ if the codes are excluded.

See Also:

getRecordCodes()

setStartPosition

public void setStartPosition(java.lang.Integer pStartPosition)

Sets the start position of the column in the row.

Parameters:

pStartPosition - the start position.

See Also:

getStartPosition()

isRecordCodesExcluded

public boolean isRecordCodesExcluded()

Returns true if the rows respecting the record codes will be excluded instead of being included when loading the file.

Returns:

if records will be excluded or included

See Also:

setRecordCodesExcluded(boolean pExcludeRecordCodes)

setRecordCodesExcluded

public void setRecordCodesExcluded(boolean pExcludeRecordCodes)

Sets if the rows respecting the record codes will be excluded instead of being included when loading the file.

Parameters:

pExcludeRecordCodes - records will be excluded if true

See Also:

isRecordCodesExcluded()

getRecordCodeList

public java.lang.String[] getRecordCodeList()

Returns the record codes. See documentation for more information.

Specified by:

getRecordCodeList in interface IFileFieldDescriptor

Returns:

the record codes.

See Also:

setRecordCodeList(String[] pRecordCodeList)

setRecordCodeList

public void setRecordCodeList(java.lang.String[] pRecordCodeList)

Sets the record codes.

Parameters:

pRecordCodeList - the list of record codes

See Also:

getRecordCodeList()

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

getOnErrorOptionString

public java.lang.String getOnErrorOptionString()

Description copied from interface: IFileFieldDescriptor

Returns the OnError option for this field. This option provides the possible action that can be taken during file loading if the actual content of the file does not match the column definition.

Possible values are: REJECT, SET_NULL_NO_TRACE, SET_NULL_TRACE, and FAIL. Default value is FAIL.

Specified by:

getOnErrorOptionString in interface IFileFieldDescriptor

Returns:

the option value

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.