Class FixedWidthPipelineInput

Method Details

• getName

  public String getName()

  Description copied from class: PipelineInput

  Returns a display name for this input, such as the source's name followed by its format.

  Overrides:

  getName in class FileSourcePipelineInput

• getFileSource

  public FileSource getFileSource()

  Specified by:

  getFileSource in class FileSourcePipelineInput

• setFileSource

  public FixedWidthPipelineInput setFileSource(FileSource fileSource)

  Specified by:

  setFileSource in class FileSourcePipelineInput

• getFields

  public List<FixedWidthField> getFields()

• setFields

  public FixedWidthPipelineInput setFields(List<FixedWidthField> fields)

• addField

  public FixedWidthPipelineInput addField(FixedWidthField field)

• addFields

  public FixedWidthPipelineInput addFields(int... width)

  Appends unnamed, left-aligned columns of the given widths that use the input's fill character.

• addField

  public FixedWidthPipelineInput addField(String name, int width)

  Appends a left-aligned column that uses the input's fill character.

• addField

  public FixedWidthPipelineInput addField(String name, int width, FixedWidthAlign align, Character fillChar)

  Appends a column with its own alignment and fill character; a null fill character uses the input's.

• skipField

  public FixedWidthPipelineInput skipField(int width)

  Appends a column of the given width whose text is discarded instead of read into a field.

• getFillChar

  public char getFillChar()

  Returns the character trimmed from values in columns without their own fill character (defaults to space).

• setFillChar

  public FixedWidthPipelineInput setFillChar(char fillChar)

  Sets the character trimmed from values in columns without their own fill character (defaults to space).

• isLastFieldConsumesRemaining

  public boolean isLastFieldConsumesRemaining()

  Indicates if the last field takes the rest of each line regardless of its width (defaults to false).

• setLastFieldConsumesRemaining

  public FixedWidthPipelineInput setLastFieldConsumesRemaining(boolean lastFieldConsumesRemaining)

  Indicates if the last field takes the rest of each line regardless of its width (defaults to false).

• isSkipEmptyRows

  public boolean isSkipEmptyRows()

  Indicates if rows with only null values are skipped (defaults to false).

• setSkipEmptyRows

  public FixedWidthPipelineInput setSkipEmptyRows(boolean skipEmptyRows)

  Indicates if rows with only null values are skipped (defaults to false).

• isFieldNamesInFirstRow

  public boolean isFieldNamesInFirstRow()

  Indicates if the first row holds the field names (defaults to false).

• setFieldNamesInFirstRow

  public FixedWidthPipelineInput setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

  Indicates if the first row holds the field names (defaults to false).

• createDataReader

  public DataReader createDataReader()

• generateJavaCode

  public void generateJavaCode(JavaCodeBuilder code)

  Description copied from interface: JavaCodeGenerator

  Appends Java source code representing this object to the given builder.

• getCharset

  public String getCharset()

  Returns the character set used to read the file (defaults to UTF-8); blank uses the platform default.

• setCharset

  public FixedWidthPipelineInput setCharset(String charset)

  Sets the character set used to read the file (defaults to UTF-8); blank uses the platform default.

• isLineageSupported

  public boolean isLineageSupported()

  Description copied from class: PipelineInput

  Indicates if this input can save data lineage on the records it reads (false unless a subclass overrides it).

  Overrides:

  isLineageSupported in class PipelineInput

• toRecord

  public Record toRecord()

  Description copied from interface: RecordSerializable

  Converts this object's state to a record that RecordSerializable.fromRecord(Record) can load.

  Specified by:

  toRecord in interface RecordSerializable

  Overrides:

  toRecord in class PipelineInput

• fromRecord

  public FixedWidthPipelineInput fromRecord(Record source)

  Description copied from interface: RecordSerializable

  Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

  Specified by:

  fromRecord in interface RecordSerializable

  Overrides:

  fromRecord in class PipelineInput

  Parameters:

  source -

  Returns:

  this instance.

• toXmlElement

  public Element toXmlElement(Document document)

  Description copied from interface: XmlSerializable

  Returns an element, created with document, describing this object; the default implementation throws a DataException.

  Specified by:

  toXmlElement in interface XmlSerializable

  Overrides:

  toXmlElement in class PipelineInput

• fromXmlElement

  public FixedWidthPipelineInput fromXmlElement(Element pipelineInputElement)

  Specified by:

  fromXmlElement in interface XmlSerializable

  Overrides:

  fromXmlElement in class PipelineInput