nl.inl.blacklab.index

Class DocIndexerFactoryConfig

java.lang.Object

nl.inl.blacklab.index.DocIndexerFactoryConfig

All Implemented Interfaces:

DocIndexerFactory

public class DocIndexerFactoryConfig
extends Object
implements DocIndexerFactory

A DocIndexerFactory implementation that automatically adds configurations in the formats/ dir in the jar and scans the default config directories for subdirectories called "config", then loads any configurations within those directories. Instances of this class can be used to add additional configs within customized directories.

Nested Class Summary

Nested classes/interfaces inherited from interface nl.inl.blacklab.index.DocIndexerFactory

DocIndexerFactory.Format

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<String,Optional<ConfigInputFormat>>	finder Return a config from the supported list, or load it if it's in the unloaded list.
protected Map<String,String>	formatErrors
protected boolean	isInitialized
protected Map<String,ConfigInputFormat>	supported
protected Map<String,File>	unloaded

Constructor Summary

Constructors

Constructor and Description
DocIndexerFactoryConfig()

Method Summary

Modifier and Type	Method and Description
protected void	addFormat(ConfigInputFormat format)
void	addFormatsInDirectories(List<File> dirs) Locate all config files (files ending with .blf.yaml, .blf.yml, .blf.json) within the list of directories and load them.
String	formatError(String formatIdentifier) If this format exists but has an error, return the error.
DocIndexerConfig	get(String formatIdentifier, DocWriter indexer, String documentName, byte[] b, Charset cs) Instantiating a DocIndexer from a byte array.
DocIndexerConfig	get(String formatIdentifier, DocWriter indexer, String documentName, File f, Charset cs) Instantiating a DocIndexer from a file.
DocIndexerConfig	get(String formatIdentifier, DocWriter indexer, String documentName, InputStream is, Charset cs) Instantiating a DocIndexer from an input stream.
DocIndexerConfig	get(String formatIdentifier, DocWriter indexer, String documentName, Reader reader) Instantiating a DocIndexer from a reader.
DocIndexerFactory.Format	getFormat(String formatIdentifier) Get the full format from its identifier.
List<DocIndexerFactory.Format>	getFormats() Return all formats supported by this factory.
void	init() Don't call manually, is called when this factory is added to the DocumentFormats registry (DocumentFormats.registerFactory(DocIndexerFactory)).
boolean	isSupported(String formatIdentifier) Can this factory instantiate a docIndexer for this type of format.
protected Optional<ConfigInputFormat>	load(String formatIdentifier, File f)
protected void	loadUnloaded()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isInitialized

protected boolean isInitialized

unloaded

protected Map<String,File> unloaded

supported

protected Map<String,ConfigInputFormat> supported

formatErrors

protected Map<String,String> formatErrors

finder

protected Function<String,Optional<ConfigInputFormat>> finder

Return a config from the supported list, or load it if it's in the unloaded list.

Why this function? Formats can depend on each other, and this is a mechanism to allow formats to get/lazy-load other formats registered with this factory. Why lazy-loading? Formats only refer to other formats by their name, not their file location, so we need to find them all before we actually load them. Those found config files are kept in the unloaded map until they are loaded

Constructor Detail

DocIndexerFactoryConfig

public DocIndexerFactoryConfig()

Method Detail

init

public void init()
          throws InvalidInputFormatConfig

Description copied from interface: DocIndexerFactory

Don't call manually, is called when this factory is added to the DocumentFormats registry (DocumentFormats.registerFactory(DocIndexerFactory)).

Specified by:

init in interface DocIndexerFactory

Throws:

InvalidInputFormatConfig

isSupported

public boolean isSupported(String formatIdentifier)

Description copied from interface: DocIndexerFactory

Can this factory instantiate a docIndexer for this type of format. This function will always be called prior to get().

Specified by:

isSupported in interface DocIndexerFactory

Parameters:

formatIdentifier - lowercased and never null or empty string

Returns:

true if this factory is able to create a docIndexer for the requested formatIdentifier

getFormats

public List<DocIndexerFactory.Format> getFormats()

Description copied from interface: DocIndexerFactory

Return all formats supported by this factory.

Specified by:

getFormats in interface DocIndexerFactory

Returns:

the list

getFormat

public DocIndexerFactory.Format getFormat(String formatIdentifier)

Description copied from interface: DocIndexerFactory

Get the full format from its identifier.

Specified by:

getFormat in interface DocIndexerFactory

Returns:

the format

addFormat

protected void addFormat(ConfigInputFormat format)
                  throws InvalidInputFormatConfig

Throws:

InvalidInputFormatConfig

addFormatsInDirectories

public void addFormatsInDirectories(List<File> dirs)
                             throws InvalidInputFormatConfig

Locate all config files (files ending with .blf.yaml, .blf.yml, .blf.json) within the list of directories and load them. Formats will use their filename (excluding the .blf.* extension) as a unique identifier. Duplicate formats are ignored. Note that the actual loading of the configs is deferred until this factory is initialized by registering it with DocumentFormats, if not already done. This is a one-time scan, so configs placed in these directories after this scan will not be picked up.

If any of the config files depend on other config files, the locations of those dependencies must also be provided in this list of directories. If config A refers to config B, then the directory where config B is located must also be present in the dirs list.

Parameters:

dirs -

Throws:

InvalidInputFormatConfig - when one of the formats could not be loaded

load

protected Optional<ConfigInputFormat> load(String formatIdentifier,
                                           File f)
                                    throws IOException

Throws:

IOException

loadUnloaded

protected void loadUnloaded()

get

public DocIndexerConfig get(String formatIdentifier,
                            DocWriter indexer,
                            String documentName,
                            Reader reader)

Description copied from interface: DocIndexerFactory

Instantiating a DocIndexer from a reader.

Specified by:

get in interface DocIndexerFactory

Parameters:

formatIdentifier - the formatIdentifier for the document

indexer - indexer object

documentName - name of the unit we're indexing

reader - text to index

Returns:

DocIndexer instance

get

public DocIndexerConfig get(String formatIdentifier,
                            DocWriter indexer,
                            String documentName,
                            InputStream is,
                            Charset cs)

Description copied from interface: DocIndexerFactory

Instantiating a DocIndexer from an input stream.

Specified by:

get in interface DocIndexerFactory

Parameters:

formatIdentifier - the formatIdentifier for the document

indexer - indexer object

documentName - name of the unit we're indexing

is - data to index

cs - default character set if not defined

Returns:

DocIndexer instance

get

public DocIndexerConfig get(String formatIdentifier,
                            DocWriter indexer,
                            String documentName,
                            File f,
                            Charset cs)
                     throws FileNotFoundException

Description copied from interface: DocIndexerFactory

Instantiating a DocIndexer from a file.

Specified by:

get in interface DocIndexerFactory

Parameters:

formatIdentifier - the formatIdentifier for the document

indexer - indexer object

documentName - name of the unit we're indexing

f - file to index

cs - default character set if not defined

Returns:

DocIndexer instance

Throws:

FileNotFoundException - if file doesn't exist

get

public DocIndexerConfig get(String formatIdentifier,
                            DocWriter indexer,
                            String documentName,
                            byte[] b,
                            Charset cs)

Description copied from interface: DocIndexerFactory

Instantiating a DocIndexer from a byte array.

Specified by:

get in interface DocIndexerFactory

Parameters:

formatIdentifier - the formatIdentifier for the document

indexer - indexer object

documentName - name of the unit we're indexing

b - data to index

cs - default character set if not defined

Returns:

DocIndexer instance

formatError

public String formatError(String formatIdentifier)

Description copied from interface: DocIndexerFactory

If this format exists but has an error, return the error.

Specified by:

formatError in interface DocIndexerFactory

Parameters:

formatIdentifier - format to check for errors

Returns:

null if not found or no errors, the error otherwise