org.docgene.plugins

Interface PluginFactory

public interface PluginFactory

The PluginFactory interface.

Method Summary

Modifier and Type	Method and Description
default CustomProperties	getCustomProperties() Return the CustomProperties (default is null, which means tht there are no custom properties).
default ElementHook	getElementHook(DirectoryParser parser, HookContext context) Return the ElementHook defined by this factory.
java.lang.String	getID() Return the factory ID.
default java.util.Map<java.lang.String,java.lang.Boolean>	getSupportedFeatures() Return the supported features.
default java.lang.String	getSupportedOutputFormat() Return the supported output format (default is null, which means that no specific output format is supported).
default boolean	hasElementHook() Return true if this factory provides an ElementHook.
default DirectoryWriter	newDirectoryWriter(ArticlesResolver resolver) Return a new DirectoryWriter (default is null, which means that no specific DirectoryWriter is provided).Note that you should provide a DirectoryWriter if the getSupportedOutputFormat() does not return null.

Method Detail

getID

java.lang.String getID()

Return the factory ID. Must be unique for each Plugin.

Returns:

the factory ID

getSupportedFeatures

default java.util.Map<java.lang.String,java.lang.Boolean> getSupportedFeatures()

Return the supported features.

Returns:

the supported features

getCustomProperties

default CustomProperties getCustomProperties()

Return the CustomProperties (default is null, which means tht there are no custom properties).

Returns:

the CustomProperties

getSupportedOutputFormat

default java.lang.String getSupportedOutputFormat()

Return the supported output format (default is null, which means that no specific output format is supported).

Returns:

the supported output format

newDirectoryWriter

default DirectoryWriter newDirectoryWriter(ArticlesResolver resolver)

Return a new DirectoryWriter (default is null, which means that no specific DirectoryWriter is provided).Note that you should provide a DirectoryWriter if the getSupportedOutputFormat() does not return null.

Parameters:

resolver - the articles resolver

Returns:

a new DirectoryWriter

hasElementHook

default boolean hasElementHook()

Return true if this factory provides an ElementHook. Return false by default. Note that you must implement the getElementHook(org.docgene.parser.DirectoryParser, org.docgene.parser.HookContext) accordingly.

Returns:

true if this factory provides an ElementHook

getElementHook

default ElementHook getElementHook(DirectoryParser parser,
                                   HookContext context)

Return the ElementHook defined by this factory. Return null by default. Note that you must implement the hasElementHook() accordingly.

Parameters:

parser - the Director Parser

context - the hook context

Returns:

the ElementHook defined by this factory