com.pervasive.datarush.operators.io.textfile

Class RecordSeparatorSettings

java.lang.Object

com.pervasive.datarush.operators.io.textfile.RecordSeparatorSettings

All Implemented Interfaces:

RecordSeparatorSpecifier

Direct Known Subclasses:

FieldDelimiterSettings

public class RecordSeparatorSettings
extends Object
implements RecordSeparatorSpecifier

A container for structural information about a file containing text records. The default settings are:

• Records are separated by "newlines", where this may be either Windows-style (CRLF) or Unix-style (LF). On read, the style will automatically be detected. On write, the system appropriate style will be used.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_NEWLINE The newline character used on the local system.

Constructor Summary

Constructors

Constructor and Description
RecordSeparatorSettings() Creates a new container with default settings.
RecordSeparatorSettings(RecordSeparatorSpecifier source) Creates a container initialized using the given structural information.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAutoDiscoverNewline() Indicates whether automated newline discovery is configured.
String	getRecordSeparator() Gets the value used as a record separator in structured text.
void	set(RecordSeparatorSpecifier options) Copy the settings from the given structure specifier.
void	setAutoDiscoverNewline(boolean enabled) Sets whether automated newline discovery is configured.
void	setRecordSeparator(String separator) Set the value to use as a record separator when reading or writing text files.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_NEWLINE

public static final String SYSTEM_NEWLINE

The newline character used on the local system.

Constructor Detail

RecordSeparatorSettings

public RecordSeparatorSettings()

Creates a new container with default settings.

RecordSeparatorSettings

public RecordSeparatorSettings(RecordSeparatorSpecifier source)

Creates a container initialized using the given structural information.

Parameters:

source - record specifier data from which to initialize the settings

Method Detail

set

public void set(RecordSeparatorSpecifier options)

Description copied from interface: RecordSeparatorSpecifier

Copy the settings from the given structure specifier.

Specified by:

set in interface RecordSeparatorSpecifier

Parameters:

options - record specifier containing the desired settings

getRecordSeparator

public String getRecordSeparator()

Description copied from interface: RecordSeparatorSpecifier

Gets the value used as a record separator in structured text.

Specified by:

getRecordSeparator in interface RecordSeparatorSpecifier

Returns:

the text value of the record separator

setRecordSeparator

public void setRecordSeparator(String separator)

Description copied from interface: RecordSeparatorSpecifier

Set the value to use as a record separator when reading or writing text files. When reading, the separator is used to parse the input text into records. When writing, the record separator will be appended at the end of every record before writing to the target file.

Setting this value disables newline style discovery.

Specified by:

setRecordSeparator in interface RecordSeparatorSpecifier

Parameters:

separator - the value to use as a record separator

See Also:

RecordSeparatorSpecifier.setAutoDiscoverNewline(boolean)

getAutoDiscoverNewline

public boolean getAutoDiscoverNewline()

Description copied from interface: RecordSeparatorSpecifier

Indicates whether automated newline discovery is configured.

Specified by:

getAutoDiscoverNewline in interface RecordSeparatorSpecifier

Returns:

true if newline style discovery is enabled, false otherwise.

setAutoDiscoverNewline

public void setAutoDiscoverNewline(boolean enabled)

Description copied from interface: RecordSeparatorSpecifier

Sets whether automated newline discovery is configured. When set, the record separator is assumed to be either UNIX- or DOS-style newline. By default, this is enabled.

Enabling this changes the the record separator to the default line separator for the installed operating system of the execution environment. It should be also noted that this setting may not be recognized in all contexts.

Specified by:

setAutoDiscoverNewline in interface RecordSeparatorSpecifier

Parameters:

enabled - indicates whether to discover newline style.

See Also:

RecordSeparatorSpecifier.setRecordSeparator(String)

toString

public String toString()

Overrides:

toString in class Object