Package org.apache.metamodel.fixedwidth

Class FixedWidthConfiguration

java.lang.Object

org.apache.metamodel.util.BaseObject

org.apache.metamodel.fixedwidth.FixedWidthConfiguration

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

EbcdicConfiguration

public class FixedWidthConfiguration
extends org.apache.metamodel.util.BaseObject
implements Serializable

Configuration of metadata about a fixed width values data context.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_COLUMN_NAME_LINE
static int	NO_COLUMN_NAME_LINE

Constructor Summary

Constructors

Constructor	Description
FixedWidthConfiguration(int fixedValueWidth)
FixedWidthConfiguration(int[] valueWidth)
FixedWidthConfiguration(int columnNameLineNumber, String encoding, int fixedValueWidth)
FixedWidthConfiguration(int columnNameLineNumber, String encoding, int[] valueWidths, boolean failOnInconsistentLineWidth)
FixedWidthConfiguration(int columnNameLineNumber, String encoding, int fixedValueWidth, boolean failOnInconsistentLineWidth)
FixedWidthConfiguration(int columnNameLineNumber, org.apache.metamodel.schema.naming.ColumnNamingStrategy columnNamingStrategy, String encoding, int[] valueWidths, boolean failOnInconsistentLineWidth)
FixedWidthConfiguration(String encoding, List<FixedWidthColumnSpec> columnSpecs)
FixedWidthConfiguration(String encoding, List<FixedWidthColumnSpec> columnSpecs, boolean failOnInconsistentLineWidth)

Method Summary

Modifier and Type	Method	Description
protected void	decorateIdentity(List<Object> identifiers)
int	getColumnNameLineNumber()	The line number (1 based) from which to get the names of the columns.
org.apache.metamodel.schema.naming.ColumnNamingStrategy	getColumnNamingStrategy()	Gets a ColumnNamingStrategy to use if needed.
String	getEncoding()	Gets the file encoding to use for reading the file.
int	getFixedValueWidth()	Gets the width of each value within the fixed width value file.
int	getValueWidth(int columnIndex)
int[]	getValueWidths()
boolean	isConstantValueWidth()
boolean	isFailOnInconsistentLineWidth()	Determines if the DataSet.next() should throw an exception in case of inconsistent line width in the fixed width value file.
String	toString()

Methods inherited from class org.apache.metamodel.util.BaseObject

classEquals, equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_COLUMN_NAME_LINE

public static final int NO_COLUMN_NAME_LINE

See Also:

Constant Field Values

DEFAULT_COLUMN_NAME_LINE

public static final int DEFAULT_COLUMN_NAME_LINE

See Also:

Constant Field Values

Constructor Detail

FixedWidthConfiguration

public FixedWidthConfiguration(int fixedValueWidth)

FixedWidthConfiguration

public FixedWidthConfiguration(int[] valueWidth)

FixedWidthConfiguration

public FixedWidthConfiguration(int columnNameLineNumber,
                               String encoding,
                               int fixedValueWidth)

FixedWidthConfiguration

public FixedWidthConfiguration(int columnNameLineNumber,
                               String encoding,
                               int fixedValueWidth,
                               boolean failOnInconsistentLineWidth)

FixedWidthConfiguration

public FixedWidthConfiguration(int columnNameLineNumber,
                               String encoding,
                               int[] valueWidths,
                               boolean failOnInconsistentLineWidth)

FixedWidthConfiguration

public FixedWidthConfiguration(int columnNameLineNumber,
                               org.apache.metamodel.schema.naming.ColumnNamingStrategy columnNamingStrategy,
                               String encoding,
                               int[] valueWidths,
                               boolean failOnInconsistentLineWidth)

FixedWidthConfiguration

public FixedWidthConfiguration(String encoding,
                               List<FixedWidthColumnSpec> columnSpecs)

FixedWidthConfiguration

public FixedWidthConfiguration(String encoding,
                               List<FixedWidthColumnSpec> columnSpecs,
                               boolean failOnInconsistentLineWidth)

Method Detail

getColumnNameLineNumber

public int getColumnNameLineNumber()

The line number (1 based) from which to get the names of the columns.

Returns:

an int representing the line number of the column headers/names.

getColumnNamingStrategy

public org.apache.metamodel.schema.naming.ColumnNamingStrategy getColumnNamingStrategy()

Gets a ColumnNamingStrategy to use if needed.

Returns:

column naming strategy

getEncoding

public String getEncoding()

Gets the file encoding to use for reading the file.

Returns:

the text encoding to use for reading the file.

getFixedValueWidth

public int getFixedValueWidth()

Gets the width of each value within the fixed width value file.

Returns:

the fixed width to use when parsing the file.

getValueWidths

public int[] getValueWidths()

isFailOnInconsistentLineWidth

public boolean isFailOnInconsistentLineWidth()

Determines if the DataSet.next() should throw an exception in case of inconsistent line width in the fixed width value file.

Returns:

a boolean indicating whether or not to fail on inconsistent line widths.

decorateIdentity

protected void decorateIdentity(List<Object> identifiers)

Specified by:

decorateIdentity in class org.apache.metamodel.util.BaseObject

toString

public String toString()

Overrides:

toString in class org.apache.metamodel.util.BaseObject

isConstantValueWidth

public boolean isConstantValueWidth()

getValueWidth

public int getValueWidth(int columnIndex)