public static class OdiColumn.FileDescriptor extends oracle.odi.domain.support.PersistableValue implements IFileFieldDescriptor
Defines OdiColumn
properties that are specific to OdiColumns on
FILE technologies.
OdiColumn.setFileDescriptor(oracle.odi.domain.model.OdiColumn.FileDescriptor)
,
Serialized FormModifier 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.
|
Modifier and Type | Field and Description |
---|---|
static int |
DECIMAL_SEPARATOR_MAX_LENGTH
Maximum length supported for the "decimalSeparator" property.
|
Constructor and Description |
---|
OdiColumn.FileDescriptor()
Creates a new
OdiColumn.FileDescriptor . |
OdiColumn.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 . |
OdiColumn.FileDescriptor(java.lang.Integer pStartPosition,
int pBytes,
java.lang.String pLogicalFormat,
java.lang.String pRecordCodes,
java.lang.String pDecimalSeparator,
OdiColumn.FileDescriptor.OnErrorOption pOnErrorOption)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
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()
Gets a numeric id for this object, for repositories that support numeric id.
|
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.
|
public static final int DECIMAL_SEPARATOR_MAX_LENGTH
public OdiColumn.FileDescriptor()
OdiColumn.FileDescriptor
.@Deprecated public OdiColumn.FileDescriptor(java.lang.Integer pStartPosition, int pBytes, java.lang.String pLogicalFormat, java.lang.String pRecordCodes, java.lang.String pDecimalSeparator, OdiColumn.FileDescriptor.OnErrorOption pOnErrorOption)
OdiColumn.FileDescriptor
.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 OnErrorOptionpublic OdiColumn.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)
OdiColumn.FileDescriptor
.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 filepDecimalSeparator
- The decimal separator.pOnErrorOption
- The OnErrorOptionpublic int getBytes()
getBytes
in interface IFileFieldDescriptor
setBytes(int)
public java.lang.String getDecimalSeparator()
getDecimalSeparator
in interface IFileFieldDescriptor
setDecimalSeparator(String)
public java.lang.String getLogicalFormat()
getLogicalFormat
in interface IFileFieldDescriptor
setLogicalFormat(String)
public OdiColumn.FileDescriptor.OnErrorOption getOnErrorOption()
OdiColumn.FileDescriptor.OnErrorOption
for this column.
Default value is OdiColumn.FileDescriptor.OnErrorOption.FAIL
.
OdiColumn.FileDescriptor.OnErrorOption
setOnErrorOption(OnErrorOption)
@Deprecated public java.lang.String getRecordCodes()
getRecordCodeList()
setRecordCodes(String)
public java.lang.Integer getStartPosition()
getStartPosition
in interface IFileFieldDescriptor
setStartPosition(Integer)
public void setBytes(int pBytes)
pBytes
- the physical length.getBytes()
public void setDecimalSeparator(java.lang.String pDecimalSeparator)
pDecimalSeparator
- the decimal separatorDomainRuntimeException
- if pDecimalSeparator is longer than
1getDecimalSeparator()
public void setLogicalFormat(java.lang.String pLogicalFormat)
pLogicalFormat
- the date format.getLogicalFormat()
public void setOnErrorOption(OdiColumn.FileDescriptor.OnErrorOption pOnErrorOption)
OdiColumn.FileDescriptor.OnErrorOption
for this column.pOnErrorOption
- the OdiColumn.FileDescriptor.OnErrorOption
getOnErrorOption()
@Deprecated public void setRecordCodes(java.lang.String pRecordCodes)
setRecordCodeList(String[] pRecordCodeList)
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.getRecordCodes()
public void setStartPosition(java.lang.Integer pStartPosition)
pStartPosition
- the start position.getStartPosition()
public boolean isRecordCodesExcluded()
true
if the rows respecting the record codes will be
excluded instead of being included when loading the file.setRecordCodesExcluded(boolean pExcludeRecordCodes)
public void setRecordCodesExcluded(boolean pExcludeRecordCodes)
pExcludeRecordCodes
- records will be excluded if true
isRecordCodesExcluded()
public java.lang.String[] getRecordCodeList()
getRecordCodeList
in interface IFileFieldDescriptor
setRecordCodeList(String[] pRecordCodeList)
public void setRecordCodeList(java.lang.String[] pRecordCodeList)
pRecordCodeList
- the list of record codesgetRecordCodeList()
public java.lang.String getName()
IModelObject
getName
in interface IModelObject
public java.lang.String getOnErrorOptionString()
IFileFieldDescriptor
Possible values are: REJECT, SET_NULL_NO_TRACE, SET_NULL_TRACE, and FAIL. Default value is FAIL.
getOnErrorOptionString
in interface IFileFieldDescriptor
public java.lang.String getGlobalId()
IModelObject
getGlobalId
in interface IModelObject
public java.lang.Integer getNumericId()
IModelObject
getNumericId
in interface IModelObject