FileSink (Data Pipeline JavaDoc)

All Superinterfaces:: JsonSerializable, RecordSerializable, XmlSerializable

All Known Implementing Classes:: AmazonS3FileSink, LocalFileSink

public interface FileSink extends RecordSerializable, XmlSerializable

A local or remote file to write, supplying an OutputStream for its content.

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
Method Summary

Modifier and Type

Method

Description

FileSink

fromRecord(Record source)

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

String

getContentType()

long

getFileSize()

Returns the size of the file in bytes.

FileType

getFileType()

Returns the format of the file, or null if it is unknown.

String

getName()

OutputStream

getOutputStream()

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

String

getPath()

String

getUrlPath()

boolean

isAppend()

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

boolean

isLocal()

Indicates if the file is on the local file system.

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

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

Method Details
- getName
  
  String getName()
- getPath
  
  String getPath()
- getUrlPath
  
  String getUrlPath()
- isLocal
  
  boolean isLocal()
  
  Indicates if the file is on the local file system.
- getFileSize
  
  long getFileSize()
  
  Returns the size of the file in bytes.
- getContentType
  
  String getContentType()
- getFileType
  
  FileType getFileType()
  
  Returns the format of the file, or null if it is unknown.
- isAppend
  
  boolean isAppend()
  
  Indicates if getOutputStream() appends to an existing file instead of replacing it.
- getOutputStream
  
  OutputStream getOutputStream()
  
  Opens a new stream to write the file's content; the caller must close it.
- fromRecord
  
  FileSink 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
  
  Parameters:
  
  source -
  
  Returns:
  
  this instance.