Package com.gengoai.hermes.format

Class TaggedFormat.Provider

java.lang.Object

com.gengoai.hermes.format.TaggedFormat.Provider

All Implemented Interfaces:

DocFormatProvider

Enclosing class:

TaggedFormat

@MetaInfServices
public static class TaggedFormat.Provider
extends Object
implements DocFormatProvider

The type Provider.

Constructor Summary

Constructors

Constructor	Description
Provider()

Method Summary

Modifier and Type	Method	Description
DocFormat	create(@NonNull DocFormatParameters parameters)	Creates an instance of the provided DocFormat with the given set of DocFormatParameters
DocFormatParameters	getDefaultFormatParameters()
String	getName()
boolean	isWriteable()

Methods inherited from class java.lang.Object

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

Constructor Detail

Provider

public Provider()

Method Detail

create

public DocFormat create(@NonNull
                        @NonNull DocFormatParameters parameters)

Description copied from interface: DocFormatProvider

Creates an instance of the provided DocFormat with the given set of DocFormatParameters

Specified by:

create in interface DocFormatProvider

Parameters:

parameters - the format parameters

Returns:

the doc format

getDefaultFormatParameters

public DocFormatParameters getDefaultFormatParameters()

Specified by:

getDefaultFormatParameters in interface DocFormatProvider

Returns:

the default DocFormatParameters

getName

public String getName()

Specified by:

getName in interface DocFormatProvider

Returns:

the format name used to identify it when constructing document collections.

isWriteable

public boolean isWriteable()

Specified by:

isWriteable in interface DocFormatProvider

Returns:

True if this format supports writing, False if not.