com.northconcepts.datapipeline.foundations.file.LocalFileSink

All Implemented Interfaces:: DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, FileSink, Serializable

public class LocalFileSink extends LocalFile implements FileSink

A FileSink that writes a file on the local file system, replacing or appending to its content.

See Also:

Field Summary

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
SERIALIZED_CLASS_NAME, TYPE

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
XML_SERIALIZED_CLASS_NAME
Constructor Summary

Constructors

Constructor

Description

LocalFileSink()
Method Summary

Modifier and Type

Method

Description

LocalFileSink

detectFileType()

Detects the file type from the file's extension or content, replacing any type already set.

LocalFileSink

fromRecord(Record source)

Loads this instance's state from a record and returns this (for fluid API call chaining).

LocalFileSink

fromXmlElement(Element localFileSinkElement)

OutputStream

getOutputStream()

Opens a new stream to write the file's content; the caller must close it.

boolean

isAppend()

Indicates if FileSink.getOutputStream() appends to an existing file instead of replacing it.

LocalFileSink

setAppend(boolean append)

Indicates if the output stream appends to an existing file instead of replacing it (default false).

LocalFileSink

setFileType(FileType fileType)

Sets the file type, which is otherwise detected from the file's extension or content.

LocalFileSink

setName(String name)

LocalFileSink

setNameFromPath()

Sets the name to the file name at the end of the path.

LocalFileSink

setPath(String path)

Sets the path of the local file, clearing the cached file and detected file type.

Record

toRecord()

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

Element

toXmlElement(Document document)

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

Methods inherited from class com.northconcepts.datapipeline.foundations.file.LocalFile
getContentType, getFile, getFileSize, getFileType, getName, getPath, getUrlPath, isLocal

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean
addExceptionProperties, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor
addExceptionProperties, exception, exception, exception

Methods inherited from interface com.northconcepts.datapipeline.foundations.file.FileSink
getContentType, getFileSize, getFileType, getName, getPath, getUrlPath, isLocal

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
fromJson, fromJson, toJson, toJson, toJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
fromXml, fromXml, toXml, toXml, toXml, toXml, toXml

Constructor Details
- LocalFileSink
  
  public LocalFileSink()
Method Details
- getOutputStream
  
  public OutputStream getOutputStream()
  
  Description copied from interface: FileSink
  
  Opens a new stream to write the file's content; the caller must close it.
  
  Specified by:
  
  getOutputStream in interface FileSink
- isAppend
  
  public boolean isAppend()
  
  Description copied from interface: FileSink
  
  Indicates if FileSink.getOutputStream() appends to an existing file instead of replacing it.
  
  Specified by:
  
  isAppend in interface FileSink
- setAppend
  
  public LocalFileSink setAppend(boolean append)
  
  Indicates if the output stream appends to an existing file instead of replacing it (default false).
- setName
  
  public LocalFileSink setName(String name)
  
  Overrides:
  
  setName in class LocalFile
- setPath
  
  public LocalFileSink setPath(String path)
  
  Description copied from class: LocalFile
  
  Sets the path of the local file, clearing the cached file and detected file type.
  
  Overrides:
  
  setPath in class LocalFile
- setNameFromPath
  
  public LocalFileSink setNameFromPath()
  
  Description copied from class: LocalFile
  
  Sets the name to the file name at the end of the path.
  
  Overrides:
  
  setNameFromPath in class LocalFile
- setFileType
  
  public LocalFileSink setFileType(FileType fileType)
  
  Description copied from class: LocalFile
  
  Sets the file type, which is otherwise detected from the file's extension or content.
  
  Overrides:
  
  setFileType in class LocalFile
- 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 LocalFile
- fromRecord
  
  public LocalFileSink 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 FileSink
  
  Specified by:
  
  fromRecord in interface RecordSerializable
  
  Overrides:
  
  fromRecord in class LocalFile
  
  Parameters:
  
  source -
  
  Returns:
  
  this instance.
- detectFileType
  
  public LocalFileSink detectFileType()
  
  Description copied from class: LocalFile
  
  Detects the file type from the file's extension or content, replacing any type already set.
  
  Overrides:
  
  detectFileType in class LocalFile
- 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 LocalFile
- fromXmlElement
  
  public LocalFileSink fromXmlElement(Element localFileSinkElement)
  
  Specified by:
  
  fromXmlElement in interface XmlSerializable
  
  Overrides:
  
  fromXmlElement in class LocalFile

Class LocalFileSink

Field Summary

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.foundations.file.LocalFile

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

Methods inherited from class java.lang.Object

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

Methods inherited from interface com.northconcepts.datapipeline.foundations.file.FileSink

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Constructor Details

LocalFileSink

Method Details

getOutputStream

isAppend

setAppend

setName

setPath

setNameFromPath

setFileType

toRecord

fromRecord

detectFileType

toXmlElement

fromXmlElement