com.pervasive.datarush.operators.io.textfile

Interface RecordSeparatorSpecifier

All Known Subinterfaces:

FieldDelimiterSpecifier

All Known Implementing Classes:

FieldDelimiterSettings, RecordSeparatorSettings

public interface RecordSeparatorSpecifier

A collection of structural information about a text file consisting of records. This provides information about identifying individual records.

Method Summary

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 source) 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.

Method Detail

set

void set(RecordSeparatorSpecifier source)

Copy the settings from the given structure specifier.

Parameters:

source - record specifier containing the desired settings

getRecordSeparator

String getRecordSeparator()

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

Returns:

the text value of the record separator

setRecordSeparator

void setRecordSeparator(String separator)

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.

Parameters:

separator - the value to use as a record separator

Throws:

InvalidPropertyValueException - if the separator is null or the empty string

See Also:

setAutoDiscoverNewline(boolean)

getAutoDiscoverNewline

boolean getAutoDiscoverNewline()

Indicates whether automated newline discovery is configured.

Returns:

true if newline style discovery is enabled, false otherwise.

setAutoDiscoverNewline

void setAutoDiscoverNewline(boolean enabled)

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.

Parameters:

enabled - indicates whether to discover newline style.

See Also:

setRecordSeparator(String)