|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.imaging.Input.FieldMap
public static class Input.FieldMap
Defines a mapping between an input source field to an Application
field which is used to establish the flow of index data during document creation within the InputService
.
IndexMappings are required to be one-to-one for their particular index. This means that any given Application field and index field may only be used once within a given set of IndexMappings
. This is validated when an Input
is added via InputService#addInputDefinition(Input)
.
Constructor Summary | |
---|---|
Input.FieldMap() Constructs a new IndexMapping without initializing the Input.IndexMapping#getInputField() or Input.IndexMapping#getApplicationField() fields. |
|
Input.FieldMap(java.lang.String sourceInputSection, NameId targetApplicationField) Constructs a new IndexMapping and initializes the Input.IndexMapping#getInputField() and Input.IndexMapping#getApplicationField() fields with the provided values. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o) When equality is evaluated between IndexMapping instances, this override will test to see if the Input.IndexMapping#getInputField() and Input.IndexMapping#getApplicationField() fields for the primaryMappings match. |
NameId |
getApplicationField() Retrieves the name of the Application field into which the index data for this mapping is stored during document creation or update. |
java.lang.String |
getDateFormat() Retrieves the expected Date format for the field mapping. |
java.lang.String |
getInputSection() Retrieves the name of a field from the input source from which the index data for this mapping originates. |
boolean |
getUseDefault() Retrieves the default behavior of the mapping. |
void |
setApplicationField(NameId to) Sets the name of the Application field into which the index data for this mapping is stored. |
void |
setDateFormat(java.lang.String dateFormat) Saves the expected date format for the column mapping. |
void |
setDefaultValue(boolean enableDefault) Enables or disables using the application field's default during processing. |
void |
setInputSection(java.lang.String from) Sets the name of the input source field from which the index data for this mapping originates. |
java.lang.String |
toString() Returns a String in the format: Input.IndexMapping#getInputField() -> Input.IndexMapping#getApplicationField() . |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Input.FieldMap()
Input.IndexMapping#getInputField()
or Input.IndexMapping#getApplicationField()
fields. These fields must be set before this mapping will be valid.public Input.FieldMap(java.lang.String sourceInputSection, NameId targetApplicationField)
Input.IndexMapping#getInputField()
and Input.IndexMapping#getApplicationField()
fields with the provided values.
sourceInputSection
- the name of an input source fieldtargetApplicationField
- the NameId value of an Application
fieldMethod Detail |
---|
public boolean equals(java.lang.Object o)
Input.IndexMapping#getInputField()
and Input.IndexMapping#getApplicationField()
fields for the primaryMappings match.
Note: If no getFrom()
or getTo()
value has been set for this IndexMapping, equals(Object)
will always return false
.
equals
in class java.lang.Object
o
- the Object to evaluate equality withtrue
if o
is an IndexMapping with the same fields as this IndexMapping; otherwise, false
public java.lang.String getInputSection()
public NameId getApplicationField()
Application
field into which the index data for this mapping is stored during document creation or update.public void setInputSection(java.lang.String from)
null
or empty.from
- the name of an input source fieldpublic void setApplicationField(NameId to)
Application
field into which the index data for this mapping is stored. This value may not be null
or empty.to
- the name of an Application fieldpublic java.lang.String toString()
Input.IndexMapping#getInputField()
-> Input.IndexMapping#getApplicationField()
.toString
in class java.lang.Object
public void setDefaultValue(boolean enableDefault)
enableDefault
- Switch to turn using defaults on or off.public boolean getUseDefault()
public void setDateFormat(java.lang.String dateFormat)
SimpleDateFormat
javadoc.dateFormat
-public java.lang.String getDateFormat()
|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |