Skip navigation links

oracle.imaging
Class Input.FieldMap

java.lang.Object
oracle.imaging.Input.FieldMap

Enclosing class:

Input

public static class Input.FieldMap

extends java.lang.Object

Defines a mapping between an input source field to an Applicationfield 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).

Author:

bturner

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

Input.FieldMap

public Input.FieldMap()

Constructs a new IndexMapping without initializing the Input.IndexMapping#getInputField()or Input.IndexMapping#getApplicationField()fields. These fields must be set before this mapping will be valid.

Input.FieldMap

public 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.

Parameters:

sourceInputSection - the name of an input source field

targetApplicationField - the NameId value of an Applicationfield

Method Detail

equals

public 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.

Note: If no getFrom() or getTo() value has been set for this IndexMapping, equals(Object) will always return false.

Overrides:

equals in class java.lang.Object

Parameters:

o - the Object to evaluate equality with

Returns:

true if o is an IndexMapping with the same fields as this IndexMapping; otherwise, false

getInputSection

public java.lang.String getInputSection()

Retrieves the name of a field from the input source from which the index data for this mapping originates.

Returns:

the name of an input source field

getApplicationField

public NameId getApplicationField()

Retrieves the name of the Application field into which the index data for this mapping is stored during document creation or update.

Returns:

the name of an Application field

setInputSection

public void setInputSection(java.lang.String from)

Sets the name of the input source field from which the index data for this mapping originates. This value may not be null or empty.

Parameters:

from - the name of an input source field

setApplicationField

public void setApplicationField(NameId to)

Sets the name of the Application field into which the index data for this mapping is stored. This value may not be null or empty.

Parameters:

to - the name of an Application field

toString

public java.lang.String toString()

Returns a String in the format:
Input.IndexMapping#getInputField()-> Input.IndexMapping#getApplicationField().

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this mapping

setDefaultValue

public void setDefaultValue(boolean enableDefault)

Enables or disables using the application field's default during processing.

Parameters:

enableDefault - Switch to turn using defaults on or off.

getUseDefault

public boolean getUseDefault()

Retrieves the default behavior of the mapping. If use default is enabled then the application field's default value will be used for indexing when a value is not supplied for the mapping during Input processing.

Returns:

A boolean that indicates if default processing is enabled or disabled.

setDateFormat

public void setDateFormat(java.lang.String dateFormat)

Saves the expected date format for the column mapping. If the destination application field is a Date type then this format will be used to convert the parsed string to a Date type; otherwise, it will be ignored. The value of the format needs to match the Date and Time patters as defined in the SimpleDateFormat javadoc.

Parameters:

dateFormat -

getDateFormat

public java.lang.String getDateFormat()

Retrieves the expected Date format for the field mapping.

Returns:

A string that contains the Date Format that will be used for parsing Date values.

Skip navigation links