Class ControlInfo

java.lang.Object

org.apache.derby.impl.load.ControlInfo

class ControlInfo
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	COLUMN_DEFINITION
(package private) static final String	COLUMN_WIDTHS
(package private) static final String	COMMA
(package private) static final String	COMMIT_COUNT
(package private) static final String	CR
(package private) static final String	CRLF
private Properties	currentProperties
(package private) static final String	DATA_CODESET
(package private) static final String	DB2_DELIMITED_FORMAT
(package private) static final String	DEFAULT_COLUMN_DEFINITION
(package private) static final String	DEFAULT_COMMIT_COUNT
(package private) static final String	DEFAULT_ESCAPE
(package private) static final String	DEFAULT_FIELD_END_DELIMITER
(package private) static final String	DEFAULT_FIELD_SEPARATOR
(package private) static final String	DEFAULT_FIELD_START_DELIMITER
(package private) static final String	DEFAULT_FORMAT
(package private) static final String	DEFAULT_NULL_STRING
(package private) static final String	DEFAULT_QUOTE
(package private) static final String	DEFAULT_RECORD_SEPARATOR
(package private) static final String	DEFAULT_START_ROW
(package private) static final String	DEFAULT_STOP_ROW
(package private) static final String	DEFAULT_VERSION
(package private) static final String	EMPTY_LINE
(package private) static final String	ESCAPE
(package private) static final String	FF
(package private) static final String	FIELD_END_DELIMITER
(package private) static final String	FIELD_SEPARATOR
(package private) static final String	FIELD_START_DELIMITER
(package private) static final String	FORMAT
(package private) static final String	HAS_DELIMETER_AT_END
(package private) static final String	INTERNAL_COMMA
(package private) static final String	INTERNAL_CR
(package private) static final String	INTERNAL_CRLF
(package private) static final String	INTERNAL_EMPTY_LINE
(package private) static final String	INTERNAL_FALSE
(package private) static final String	INTERNAL_FF
(package private) static final String	INTERNAL_LF
(package private) static final String	INTERNAL_LFCR
(package private) static final String	INTERNAL_NEWLINE
(package private) static final String	INTERNAL_NONE
(package private) static final String	INTERNAL_SEMICOLON
(package private) static final String	INTERNAL_SPACE
(package private) static final String	INTERNAL_TAB
(package private) static final String	INTERNAL_TRUE
(package private) static final String	LF
(package private) static final String	LFCR
(package private) static final String	MESSAGE_FILE
(package private) static final String	NEWLINE
(package private) static final String	NULL_STRING
(package private) static final String	QUOTE
(package private) static final String	RECORD_SEPARATOR
(package private) static final String	SEMICOLON
(package private) static final String	SPACE
(package private) static final String	START_ROW
(package private) static final String	STOP_ROW
(package private) static final String	TAB
(package private) static final String	VERSION

Constructor Summary

Constructors

Constructor	Description
ControlInfo()

Method Summary

Modifier and Type	Method	Description
private String	commonToFieldAndRecordDelimiters(String aDelimiter, String specialChars, char replacementChar)
(package private) String	getColumnDefinition()
(package private) int[]	getColumnWidths()
(package private) Properties	getCurrentProperties()	read the control file properties into a local variable which is used later on In case there is no control file, read the default values for these properties
(package private) String	getCurrentVersion()
(package private) String	getDataCodeset()
(package private) String	getFieldEndDelimiter()
(package private) String	getFieldSeparator()
(package private) String	getFieldStartDelimiter()
(package private) String	getFormat()
(package private) String	getHasDelimeterAtEndString()
(package private) boolean	getHasDelimiterAtEnd()
(package private) String	getNullString()
(package private) String	getPropertyValue(String aKey)
(package private) String	getRecordSeparator()
private void	loadDefaultValues()
private String	mapFromUserFriendlyFieldDelimiters(String aDelimiter)
private String	mapFromUserFriendlyRecordDelimiters(String aDelimiter)
void	setCharacterDelimiter(String charDelimiter)
void	setcolumnDefinition(String columnDefinition)
void	setColumnWidths(String columnWidths)
void	setControlProperties(String characterDelimiter, String columnDelimiter, String codeset)
void	setDataCodeset(String codeset)
void	setFieldEndDelimiter(String fedl)
void	setFieldSeparator(String fieldSeperator)
void	setFieldStartDelimiter(String fsdl)
void	setHasDelimiterAtEnd(String hasDelimeterAtEnd)
void	setNullString(String nullString)
void	setRecordSeparator(String recordSeperator)
private void	validateDelimiters()

Methods inherited from class Object

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

Field Details

ESCAPE

static final String ESCAPE

See Also:

• Constant Field Values

DEFAULT_ESCAPE

static final String DEFAULT_ESCAPE

See Also:

• Constant Field Values

QUOTE

static final String QUOTE

See Also:

• Constant Field Values

DEFAULT_QUOTE

static final String DEFAULT_QUOTE

See Also:

• Constant Field Values

COMMIT_COUNT

static final String COMMIT_COUNT

See Also:

• Constant Field Values

DEFAULT_COMMIT_COUNT

static final String DEFAULT_COMMIT_COUNT

See Also:

• Constant Field Values

START_ROW

static final String START_ROW

See Also:

• Constant Field Values

DEFAULT_START_ROW

static final String DEFAULT_START_ROW

See Also:

• Constant Field Values

STOP_ROW

static final String STOP_ROW

See Also:

• Constant Field Values

DEFAULT_STOP_ROW

static final String DEFAULT_STOP_ROW

See Also:

• Constant Field Values

FIELD_SEPARATOR

static final String FIELD_SEPARATOR

See Also:

• Constant Field Values

DEFAULT_FIELD_SEPARATOR

static final String DEFAULT_FIELD_SEPARATOR

See Also:

• Constant Field Values

RECORD_SEPARATOR

static final String RECORD_SEPARATOR

See Also:

• Constant Field Values

DEFAULT_RECORD_SEPARATOR

static final String DEFAULT_RECORD_SEPARATOR

COLUMN_DEFINITION

static final String COLUMN_DEFINITION

See Also:

• Constant Field Values

DEFAULT_COLUMN_DEFINITION

static final String DEFAULT_COLUMN_DEFINITION

See Also:

• Constant Field Values

NULL_STRING

static final String NULL_STRING

See Also:

• Constant Field Values

DEFAULT_NULL_STRING

static final String DEFAULT_NULL_STRING

See Also:

• Constant Field Values

FORMAT

static final String FORMAT

See Also:

• Constant Field Values

DEFAULT_FORMAT

static final String DEFAULT_FORMAT

See Also:

• Constant Field Values

DB2_DELIMITED_FORMAT

static final String DB2_DELIMITED_FORMAT

See Also:

• Constant Field Values

FIELD_START_DELIMITER

static final String FIELD_START_DELIMITER

See Also:

• Constant Field Values

DEFAULT_FIELD_START_DELIMITER

static final String DEFAULT_FIELD_START_DELIMITER

See Also:

• Constant Field Values

FIELD_END_DELIMITER

static final String FIELD_END_DELIMITER

See Also:

• Constant Field Values

DEFAULT_FIELD_END_DELIMITER

static final String DEFAULT_FIELD_END_DELIMITER

See Also:

• Constant Field Values

COLUMN_WIDTHS

static final String COLUMN_WIDTHS

See Also:

• Constant Field Values

MESSAGE_FILE

static final String MESSAGE_FILE

See Also:

• Constant Field Values

DEFAULT_VERSION

static final String DEFAULT_VERSION

See Also:

• Constant Field Values

VERSION

static final String VERSION

See Also:

• Constant Field Values

NEWLINE

static final String NEWLINE

See Also:

• Constant Field Values

COMMA

static final String COMMA

See Also:

• Constant Field Values

SPACE

static final String SPACE

See Also:

• Constant Field Values

TAB

static final String TAB

See Also:

• Constant Field Values

CR

static final String CR

See Also:

• Constant Field Values

LF

static final String LF

See Also:

• Constant Field Values

CRLF

static final String CRLF

See Also:

• Constant Field Values

LFCR

static final String LFCR

See Also:

• Constant Field Values

FF

static final String FF

See Also:

• Constant Field Values

EMPTY_LINE

static final String EMPTY_LINE

See Also:

• Constant Field Values

SEMICOLON

static final String SEMICOLON

See Also:

• Constant Field Values

DATA_CODESET

static final String DATA_CODESET

See Also:

• Constant Field Values

HAS_DELIMETER_AT_END

static final String HAS_DELIMETER_AT_END

See Also:

• Constant Field Values

INTERNAL_NONE

static final String INTERNAL_NONE

See Also:

• Constant Field Values

INTERNAL_TRUE

static final String INTERNAL_TRUE

See Also:

• Constant Field Values

INTERNAL_FALSE

static final String INTERNAL_FALSE

See Also:

• Constant Field Values

INTERNAL_TAB

static final String INTERNAL_TAB

See Also:

• Constant Field Values

INTERNAL_SPACE

static final String INTERNAL_SPACE

See Also:

• Constant Field Values

INTERNAL_CR

static final String INTERNAL_CR

See Also:

• Constant Field Values

INTERNAL_LF

static final String INTERNAL_LF

See Also:

• Constant Field Values

INTERNAL_CRLF

static final String INTERNAL_CRLF

See Also:

• Constant Field Values

INTERNAL_LFCR

static final String INTERNAL_LFCR

See Also:

• Constant Field Values

INTERNAL_COMMA

static final String INTERNAL_COMMA

See Also:

• Constant Field Values

INTERNAL_SEMICOLON

static final String INTERNAL_SEMICOLON

See Also:

• Constant Field Values

INTERNAL_NEWLINE

static final String INTERNAL_NEWLINE

See Also:

• Constant Field Values

INTERNAL_FF

static final String INTERNAL_FF

See Also:

• Constant Field Values

INTERNAL_EMPTY_LINE

static final String INTERNAL_EMPTY_LINE

See Also:

• Constant Field Values

currentProperties

private Properties currentProperties

Constructor Details

ControlInfo

public ControlInfo()
            throws Exception

Throws:

Exception

Method Details

getPropertyValue

String getPropertyValue(String aKey)
                 throws Exception

Throws:

Exception

loadDefaultValues

private void loadDefaultValues()

getCurrentVersion

String getCurrentVersion()
                  throws Exception

Throws:

Exception

getFormat

String getFormat()
          throws Exception

Throws:

Exception

getColumnWidths

int[] getColumnWidths()

getFieldSeparator

String getFieldSeparator()
                  throws Exception

Throws:

Exception

getFieldStartDelimiter

String getFieldStartDelimiter()
                       throws Exception

Throws:

Exception

getFieldEndDelimiter

String getFieldEndDelimiter()
                     throws Exception

Throws:

Exception

getRecordSeparator

String getRecordSeparator()
                   throws Exception

Throws:

Exception

getHasDelimiterAtEnd

boolean getHasDelimiterAtEnd()
                      throws Exception

Throws:

Exception

getHasDelimeterAtEndString

String getHasDelimeterAtEndString()
                           throws Exception

Throws:

Exception

getNullString

String getNullString()
              throws Exception

Throws:

Exception

getColumnDefinition

String getColumnDefinition()
                    throws Exception

Throws:

Exception

mapFromUserFriendlyFieldDelimiters

private String mapFromUserFriendlyFieldDelimiters(String aDelimiter)

commonToFieldAndRecordDelimiters

private String commonToFieldAndRecordDelimiters(String aDelimiter,
 String specialChars,
 char replacementChar)

mapFromUserFriendlyRecordDelimiters

private String mapFromUserFriendlyRecordDelimiters(String aDelimiter)

getDataCodeset

String getDataCodeset()
               throws Exception

Returns:

Code set, can return null for use the default code set.

Throws:

Exception

getCurrentProperties

Properties getCurrentProperties()
                         throws Exception

read the control file properties into a local variable which is used later on In case there is no control file, read the default values for these properties

Throws:

Exception - if there is an error

setColumnWidths

public void setColumnWidths(String columnWidths)
                     throws Exception

Throws:

Exception

setFieldSeparator

public void setFieldSeparator(String fieldSeperator)
                       throws Exception

Throws:

Exception

setFieldStartDelimiter

public void setFieldStartDelimiter(String fsdl)
                            throws Exception

Throws:

Exception

setFieldEndDelimiter

public void setFieldEndDelimiter(String fedl)
                          throws Exception

Throws:

Exception

setRecordSeparator

public void setRecordSeparator(String recordSeperator)
                        throws Exception

Throws:

Exception

setHasDelimiterAtEnd

public void setHasDelimiterAtEnd(String hasDelimeterAtEnd)
                          throws Exception

Throws:

Exception

setNullString

public void setNullString(String nullString)
                   throws Exception

Throws:

Exception

setcolumnDefinition

public void setcolumnDefinition(String columnDefinition)
                         throws Exception

Throws:

Exception

setDataCodeset

public void setDataCodeset(String codeset)
                    throws Exception

Throws:

Exception

setCharacterDelimiter

public void setCharacterDelimiter(String charDelimiter)
                           throws Exception

Throws:

Exception

setControlProperties

public void setControlProperties(String characterDelimiter,
 String columnDelimiter,
 String codeset)
                          throws Exception

Throws:

Exception

validateDelimiters

private void validateDelimiters()
                         throws Exception

Throws:

Exception