Interface ItemFileGenerator
- All Known Implementing Classes:
AbstractItemFileGenerator
@NonNullByDefault
public interface ItemFileGenerator
ItemFileGenerator is the interface to implement by any file generator for Item object.- Author:
- Laurent Garnier - Initial contribution
-
Method Summary
Modifier and TypeMethodDescriptionvoidgenerateFileFormat(String id, OutputStream out) Generate the file format for all data that were associated to the provided identifier.Returns the format of the file.voidsetItemsToBeGenerated(String id, List<Item> items, Collection<Metadata> metadata, Map<String, String> stateFormatters, boolean hideDefaultParameters) Define the list of items (including metadata and channel links) to be generated and associate them to an identifier.
-
Method Details
-
getFileFormatGenerator
String getFileFormatGenerator()Returns the format of the file.- Returns:
- the file format
-
setItemsToBeGenerated
void setItemsToBeGenerated(String id, List<Item> items, Collection<Metadata> metadata, Map<String, String> stateFormatters, boolean hideDefaultParameters) Define the list of items (including metadata and channel links) to be generated and associate them to an identifier.- Parameters:
id- the identifier of the file format generationitems- the itemsmetadata- the provided collection of metadata for these items (including channel links)stateFormatters- the optional state formatter for each itemhideDefaultParameters- true to hide the configuration parameters having the default value
-
generateFileFormat
Generate the file format for all data that were associated to the provided identifier.- Parameters:
id- the identifier of the file format generationout- the output stream to write to
-