ConfigInputFormat (BlackLab 2.0.0 API)

java.lang.Object
- nl.inl.blacklab.indexers.config.ConfigInputFormat

```
public class ConfigInputFormat
extends Object
```
Configuration for an input format (either contents, or metadata, or a mix of both).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConfigInputFormat.FileType` Basic file types we support
`static class`	`ConfigInputFormat.FileTypeOption` file type options for a FileType

Constructor Summary

Constructors
Constructor and Description
`ConfigInputFormat(File file, InputFormatReader.BaseFormatFinder finder)`
`ConfigInputFormat(String name)` Construct empty input format instance.
`ConfigInputFormat(String name, Reader reader, boolean isJson, InputFormatReader.BaseFormatFinder finder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotatedField(ConfigAnnotatedField f)`
`void`	`addFileTypeOption(String key, String value)`
`void`	`addIndexFieldAs(String from, String to)`
`void`	`addLinkedDocument(ConfigLinkedDocument d)`
`void`	`addNamespace(String name, String uri)`
`ConfigMetadataBlock`	`createMetadataBlock()`
`ConfigAnnotatedField`	`getAnnotatedField(String name)`
`Map<String,ConfigAnnotatedField>`	`getAnnotatedFields()`
`String`	`getConvertPluginId()`
`ConfigCorpus`	`getCorpusConfig()`
`String`	`getDescription()`
`String`	`getDisplayName()`
`String`	`getDocumentPath()`
`ConfigInputFormat.FileType`	`getFileType()`
`Map<String,String>`	`getFileTypeOptions()`
`BufferedReader`	`getFormatFile()`
`String`	`getHelpUrl()`
`Map<String,String>`	`getIndexFieldAs()`
`ConfigLinkedDocument`	`getLinkedDocument(String name)`
`Map<String,ConfigLinkedDocument>`	`getLinkedDocuments()`
`List<ConfigMetadataBlock>`	`getMetadataBlocks()`
`String`	`getMetadataDefaultAnalyzer()`
`UnknownCondition`	`getMetadataDefaultUnknownCondition()`
`String`	`getMetadataDefaultUnknownValue()`
`ConfigMetadataField`	`getMetadataField(String fieldname)`
`String`	`getName()`
`Map<String,String>`	`getNamespaces()`
`ConfigAnnotatedField`	`getOrCreateAnnotatedField(String name)`
`ConfigLinkedDocument`	`getOrCreateLinkedDocument(String name)`
`File`	`getReadFromFile()`
`String`	`getTagPluginId()`
`String`	`getType()`
`boolean`	`isNamespaceAware()`
`boolean`	`isVisible()`
`void`	`setBaseFormat(ConfigInputFormat baseFormat)` Copy everything except name, displayName and description from the specified format.
`void`	`setConvertPluginId(String id)`
`void`	`setDescription(String description)`
`void`	`setDisplayName(String displayName)`
`void`	`setDocumentPath(String documentPath)`
`void`	`setFileType(ConfigInputFormat.FileType fileType)`
`void`	`setHelpUrl(String helpUrl)`
`void`	`setMetadataDefaultAnalyzer(String metadataDefaultAnalyzer)`
`void`	`setMetadataDefaultUnknownCondition(UnknownCondition unknownCondition)`
`void`	`setMetadataDefaultUnknownValue(String unknownValue)`
`void`	`setReadFromFile(File readFromFile)`
`void`	`setStore(boolean store)`
`void`	`setTagPluginId(String id)`
`void`	`setType(String type)`
`void`	`setVisible(boolean listed)`
`boolean`	`shouldResolveNamedEntityReferences()`
`boolean`	`shouldStore()`
`static String`	`stripExtensions(String fileName)`
`String`	`toString()`
`void`	`validate()` Validate this configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- ConfigInputFormat
```
public ConfigInputFormat(String name)
```
  Construct empty input format instance.
  
  Parameters:
  
  name - format name
- ConfigInputFormat
```
public ConfigInputFormat(File file,
                         InputFormatReader.BaseFormatFinder finder)
                  throws IOException
```
  Parameters:
  
  file - the file to read, the name of this file (minus the .blf.* extension) will be used as this format's name.
  
  finder - finder to locate the baseFormat of this config, if set, may be null if no baseFormat is required
  
  Throws:
  
  IOException - on error
- ConfigInputFormat
```
public ConfigInputFormat(String name,
                         Reader reader,
                         boolean isJson,
                         InputFormatReader.BaseFormatFinder finder)
                  throws IOException
```
  Parameters:
  
  name - format name
  
  reader - format file to read
  
  isJson - true if json, false if yaml
  
  finder - finder to locate the baseFormat of this config, if set, may be null if no baseFormat is required
  
  Throws:
  
  IOException

Method Detail

setBaseFormat
```
public void setBaseFormat(ConfigInputFormat baseFormat)
```
Copy everything except name, displayName and description from the specified format.

Parameters:

baseFormat - format to copy from

validate
```
public void validate()
```
Validate this configuration.

getName
```
public String getName()
```

getDisplayName
```
public String getDisplayName()
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

setDisplayName

public void setDisplayName(String displayName)

getFileType

public ConfigInputFormat.FileType getFileType()

setFileType

public void setFileType(ConfigInputFormat.FileType fileType)

isVisible
```
public boolean isVisible()
```

setVisible

public void setVisible(boolean listed)

addNamespace

public void addNamespace(String name,
                         String uri)

setDocumentPath

public void setDocumentPath(String documentPath)

createMetadataBlock

public ConfigMetadataBlock createMetadataBlock()

getMetadataBlocks

public List<ConfigMetadataBlock> getMetadataBlocks()

addAnnotatedField

public void addAnnotatedField(ConfigAnnotatedField f)

addLinkedDocument

public void addLinkedDocument(ConfigLinkedDocument d)

setConvertPluginId

public void setConvertPluginId(String id)

getConvertPluginId
```
public String getConvertPluginId()
```

setTagPluginId

public void setTagPluginId(String id)

getTagPluginId
```
public String getTagPluginId()
```

isNamespaceAware
```
public boolean isNamespaceAware()
```

getNamespaces

public Map<String,String> getNamespaces()

getDocumentPath
```
public String getDocumentPath()
```

getAnnotatedFields

public Map<String,ConfigAnnotatedField> getAnnotatedFields()

getAnnotatedField

public ConfigAnnotatedField getAnnotatedField(String name)

getOrCreateAnnotatedField

public ConfigAnnotatedField getOrCreateAnnotatedField(String name)

getLinkedDocuments

public Map<String,ConfigLinkedDocument> getLinkedDocuments()

getLinkedDocument

public ConfigLinkedDocument getLinkedDocument(String name)

getOrCreateLinkedDocument

public ConfigLinkedDocument getOrCreateLinkedDocument(String name)

getIndexFieldAs

public Map<String,String> getIndexFieldAs()

addIndexFieldAs

public void addIndexFieldAs(String from,
                            String to)

shouldStore
```
public boolean shouldStore()
```

setStore
```
public void setStore(boolean store)
```

getMetadataDefaultAnalyzer

public String getMetadataDefaultAnalyzer()

setMetadataDefaultAnalyzer

public void setMetadataDefaultAnalyzer(String metadataDefaultAnalyzer)

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getFileTypeOptions

public Map<String,String> getFileTypeOptions()

addFileTypeOption

public void addFileTypeOption(String key,
                              String value)

getCorpusConfig
```
public ConfigCorpus getCorpusConfig()
```

getMetadataField

public ConfigMetadataField getMetadataField(String fieldname)

stripExtensions

public static String stripExtensions(String fileName)

getReadFromFile
```
public File getReadFromFile()
```

getFormatFile
```
public BufferedReader getFormatFile()
```

setReadFromFile

public void setReadFromFile(File readFromFile)

shouldResolveNamedEntityReferences

public boolean shouldResolveNamedEntityReferences()

getHelpUrl
```
public String getHelpUrl()
```

setHelpUrl

public void setHelpUrl(String helpUrl)

toString
```
public String toString()
```
Overrides:

toString in class Object

getMetadataDefaultUnknownCondition

public UnknownCondition getMetadataDefaultUnknownCondition()

getMetadataDefaultUnknownValue

public String getMetadataDefaultUnknownValue()

setMetadataDefaultUnknownCondition

public void setMetadataDefaultUnknownCondition(UnknownCondition unknownCondition)

setMetadataDefaultUnknownValue

public void setMetadataDefaultUnknownValue(String unknownValue)

Class ConfigInputFormat

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigInputFormat

ConfigInputFormat

ConfigInputFormat

Method Detail

setBaseFormat

validate

getName

getDisplayName

getDescription

setDescription

setDisplayName

getFileType

setFileType

isVisible

setVisible

addNamespace

setDocumentPath

createMetadataBlock

getMetadataBlocks

addAnnotatedField

addLinkedDocument

setConvertPluginId

getConvertPluginId

setTagPluginId

getTagPluginId

isNamespaceAware

getNamespaces

getDocumentPath

getAnnotatedFields

getAnnotatedField

getOrCreateAnnotatedField

getLinkedDocuments

getLinkedDocument

getOrCreateLinkedDocument

getIndexFieldAs

addIndexFieldAs

shouldStore

setStore

getMetadataDefaultAnalyzer

setMetadataDefaultAnalyzer

getType

setType

getFileTypeOptions

addFileTypeOption

getCorpusConfig

getMetadataField

stripExtensions

getReadFromFile

getFormatFile

setReadFromFile

shouldResolveNamedEntityReferences

getHelpUrl

setHelpUrl

toString

getMetadataDefaultUnknownCondition

getMetadataDefaultUnknownValue

setMetadataDefaultUnknownCondition

setMetadataDefaultUnknownValue