GrobidProperties

java.lang.Object
- org.grobid.core.utilities.GrobidProperties

```
public class GrobidProperties
extends java.lang.Object
```
This class loads contains all names of grobid-properties and provide methods to load grobid-properties from a property file. Each property will be copied to a system property having the same name.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String FILE_ENDING_TEI_FULLTEXT

static java.lang.String FILE_ENDING_TEI_HEADER

static Logger LOGGER

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FILE_ENDING_TEI_FULLTEXT`
`static java.lang.String`	`FILE_ENDING_TEI_HEADER`
`static Logger`	`LOGGER`

Constructor Summary

Constructors
Constructor and Description

GrobidProperties()
Creates a new object and searches, where to find the grobid home folder.

Constructors
Constructor and Description
`GrobidProperties()` Creates a new object and searches, where to find the grobid home folder.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`checkProperties()` Checks if the given properties contains non-empty and non-null values for the properties of list Grobid properties
`static java.io.File`	`get_GROBID_HOME_PATH()` Return the GROBID_HOME path.
`static Consolidation.GrobidConsolidationService`	`getConsolidationService()` Returns the consolidation service to be used.
`static java.io.File`	`getCorpusPath(java.io.File resourcesDir, GrobidModel model)`
`static java.lang.String`	`getCrossrefMailto()` Get the "mailto" parameter to be used in the crossref query and in User-Agent header, as recommended by CrossRef REST API documentation.
`static java.lang.String`	`getCrossrefToken()` Get the Crossref Metadata Plus authorization token to be used for Crossref requests for the subscribers of this service.
`static java.lang.String`	`getDeLFTFilePath()`
`static java.lang.String`	`getDeLFTPath()` Returns the installation path of DeLFT if set, null otherwise.
`protected static java.util.Map<java.lang.String,java.lang.String>`	`getEnvironmentVariableOverrides(java.util.Map<java.lang.String,java.lang.String> environmentVariablesMap)`
`static java.io.File`	`getEvalCorpusPath(java.io.File resourcesDir, GrobidModel model)`
`static java.lang.String`	`getGluttonHost()`
`static java.lang.Integer`	`getGluttonPort()`
`static GrobidCRFEngine`	`getGrobidCRFEngine()`
`static java.io.File`	`getGrobidHomePath()`
`static java.io.File`	`getGrobidPropertiesPath()` Return the GROBID_HOME path.
`static GrobidProperties`	`getInstance()` Returns an instance of `GrobidProperties` object.
`static GrobidProperties`	`getInstance(GrobidHomeFinder grobidHomeFinder)` Returns an instance of `GrobidProperties` object based on a custom grobid-home directory.
`static java.io.File`	`getLanguageDetectionResourcePath()`
`static java.lang.String`	`getLanguageDetectorFactory()`
`static java.lang.String`	`getLexiconPath()`
`static int`	`getMaxPoolConnections()` Returns the maximum parallel connections allowed in the pool.
`static java.io.File`	`getModelPath()`
`static java.io.File`	`getModelPath(GrobidModel model)`
`static java.io.File`	`getNativeLibraryPath()` Returns the content of property GrobidPropertyKeys.PROP_NATIVE_LIB_PATH as `File` object.
`static java.lang.Integer`	`getNBThreads()` Returns the number of threads, given in the grobid-property file.
`protected static GrobidProperties`	`getNewInstance()` Creates a new `GrobidProperties` object, initializes it and returns it.
`static java.lang.Integer`	`getPdfBlocksMax()`
`static java.lang.Integer`	`getPdfTokensMax()`
`static java.lang.Integer`	`getPdfToXMLMemoryLimitMb()`
`static java.io.File`	`getPdfToXMLPath()` Returns the path to the home folder of pdf to xml program.
`static java.lang.Integer`	`getPdfToXMLTimeoutMs()`
`static int`	`getPoolMaxWait()` Returns maximum time to wait before timeout when the pool is full.
`protected static java.lang.String`	`getPropertyValue(java.lang.String pkey)` Return the value corresponding to the property key.
`protected static java.lang.String`	`getPropertyValue(java.lang.String pkey, java.lang.String pDefaultVal)` Return the value corresponding to the property key.
`static java.util.Properties`	`getProps()` Returns all grobid-properties.
`static java.lang.String`	`getProxyHost()` Returns the host for a proxy connection, given in the grobid-property file.
`static java.lang.Integer`	`getProxyPort()` Returns the port for a proxy connection, given in the grobid-property file.
`static java.lang.String`	`getPythonVirtualEnv()`
`static java.io.File`	`getTemplatePath(java.io.File resourcesDir, GrobidModel model)`
`static java.io.File`	`getTempPath()` Returns the temprorary path of grobid
`static java.lang.String`	`getVersion()` Returns the current version of GROBID
`protected static void`	`initializePaths()` Initialize the different paths set in the configuration file grobid.properties.
`static java.lang.Boolean`	`isContextExecutionServer()` Returns if the execution context is stand alone or server.
`static boolean`	`isDeLFTRedirectOutput()`
`static boolean`	`isHeaderUseHeuristics()`
`static java.lang.Boolean`	`isResourcesInHome()` Returns if resources like firstnames, lastnames and countries are supposed to be read from grobid-home folder, given in the grobid-property file.
`static java.lang.Boolean`	`isUseLanguageId()` Returns if a language id shall be used, given in the grobid-property file.
`static void`	`loadPdf2XMLPath()` Returns the path to the home folder of pdf to xml converter.
`static void`	`reload()` Reload GrobidServiceProperties.
`static void`	`reset()` Resets this class and all its static fields.
`static void`	`set_GROBID_HOME_PATH(java.lang.String pGROBID_HOME_PATH)` Set the GROBID_HOME path.
`static void`	`setConsolidationService(java.lang.String service)` Set which consolidation service to use
`static void`	`setContextExecutionServer(java.lang.Boolean state)` Set if the execution context is stand alone or server.
`static void`	`setCrossrefMailto(java.lang.String mailto)` Set the "mailto" parameter to be used in the crossref query and in User-Agent header, as recommended by CrossRef REST API documentation.
`static void`	`setCrossrefToken(java.lang.String token)` Set the Crossref Metadata Plus authorization token to be used for Crossref requests for the subscribers of this service.
`static void`	`setGrobidPropertiesPath(java.lang.String pGrobidPropertiesPath)` Set the GROBID_HOME path.
`static void`	`setNativeLibraryPath(java.lang.String nativeLibPath)`
`static void`	`setNBThreads(java.lang.String nbThreads)` Sets the number of threads, given in the grobid-property file.
`static void`	`setPropertyValue(java.lang.String pkey, java.lang.String pValue)` Return the value corresponding to the property key.
`static void`	`setProxyHost(java.lang.String host)` Sets the host a proxy connection, given in the grobid-property file.
`static void`	`setProxyPort(java.lang.String port)` Sets the port for a proxy connection, given in the grobid-property file.
`static void`	`setPythonVirtualEnv(java.lang.String pythonVirtualEnv)`
`static void`	`setResourcesInHome(java.lang.String resourceInHome)` Sets if resources like firstnames, lastnames and countries are supposed to be read from grobid-home folder, given in the grobid-property file.
`static void`	`setUseLanguageId(java.lang.String useLanguageId)` Sets if a language id shall be used, given in the grobid-property file.
`static void`	`setVersion(java.lang.String version)` Sets the GROBID version.
`static boolean`	`useELMo()`

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

- Field Detail
  - LOGGER
```
public static final Logger LOGGER
```
  - FILE_ENDING_TEI_HEADER
```
public static final java.lang.String FILE_ENDING_TEI_HEADER
```
    See Also:
    
    Constant Field Values
  - FILE_ENDING_TEI_FULLTEXT
```
public static final java.lang.String FILE_ENDING_TEI_FULLTEXT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GrobidProperties
```
public GrobidProperties()
```
    Creates a new object and searches, where to find the grobid home folder. First step is to check if the system property GrobidPropertyKeys.PROP_GROBID_HOME is set, than the path matching to that property is used. Otherwise, the method will search a folder named #FILE_GROBID_PROPERTIES_PRIVATE , if this is is also not set, the method will search for a folder named FILE_GROBID_PROPERTIES in the current project (current project means where the system property user.dir points to.)
- Method Detail
  - reset
```
public static void reset()
```
    Resets this class and all its static fields. For instance sets the current object to null.
  - getInstance
```
public static GrobidProperties getInstance()
```
    Returns an instance of GrobidProperties object. If no one is set, then it creates one.
  - getInstance
```
public static GrobidProperties getInstance(GrobidHomeFinder grobidHomeFinder)
```
    Returns an instance of GrobidProperties object based on a custom grobid-home directory. If no one is set, then it creates one.
  - reload
```
public static void reload()
```
    Reload GrobidServiceProperties.
  - getNewInstance
```
protected static GrobidProperties getNewInstance()
```
    Creates a new GrobidProperties object, initializes it and returns it.
    
    Returns:
    
    GrobidProperties
  - getProps
```
public static java.util.Properties getProps()
```
    Returns all grobid-properties.
    
    Returns:
    
    properties object
  - get_GROBID_HOME_PATH
```
public static java.io.File get_GROBID_HOME_PATH()
```
    Return the GROBID_HOME path.
    
    Returns:
    
    grobid home path
  - getGrobidHomePath
```
public static java.io.File getGrobidHomePath()
```
  - set_GROBID_HOME_PATH
```
public static void set_GROBID_HOME_PATH(java.lang.String pGROBID_HOME_PATH)
```
    Set the GROBID_HOME path.
  - getGrobidPropertiesPath
```
public static java.io.File getGrobidPropertiesPath()
```
    Return the GROBID_HOME path.
    
    Returns:
    
    grobid properties path
  - setGrobidPropertiesPath
```
public static void setGrobidPropertiesPath(java.lang.String pGrobidPropertiesPath)
```
    Set the GROBID_HOME path.
  - getPropertyValue
```
protected static java.lang.String getPropertyValue(java.lang.String pkey)
```
    Return the value corresponding to the property key. If this value is null, return the default value.
    
    Parameters:
    
    pkey - the property key
    
    Returns:
    
    the value of the property.
  - getPropertyValue
```
protected static java.lang.String getPropertyValue(java.lang.String pkey,
                                                   java.lang.String pDefaultVal)
```
    Return the value corresponding to the property key. If this value is null, return the default value.
    
    Parameters:
    
    pkey - the property key
    
    pDefaultVal - the default value
    
    Returns:
    
    the value of the property, pDefaultVal else.
  - setPropertyValue
```
public static void setPropertyValue(java.lang.String pkey,
                                    java.lang.String pValue)
```
    Return the value corresponding to the property key. If this value is null, return the default value.
    
    Parameters:
    
    pkey - the property key
  - getVersion
```
public static java.lang.String getVersion()
```
    Returns the current version of GROBID
    
    Returns:
    
    GROBID version
  - getEnvironmentVariableOverrides
```
protected static java.util.Map<java.lang.String,java.lang.String> getEnvironmentVariableOverrides(java.util.Map<java.lang.String,java.lang.String> environmentVariablesMap)
```
  - initializePaths
```
protected static void initializePaths()
```
    Initialize the different paths set in the configuration file grobid.properties.
  - checkProperties
```
protected static void checkProperties()
```
    Checks if the given properties contains non-empty and non-null values for the properties of list Grobid properties
  - getTempPath
```
public static java.io.File getTempPath()
```
    Returns the temprorary path of grobid
    
    Returns:
    
    a directory for temp files
  - setNativeLibraryPath
```
public static void setNativeLibraryPath(java.lang.String nativeLibPath)
```
  - getNativeLibraryPath
```
public static java.io.File getNativeLibraryPath()
```
    Returns the content of property GrobidPropertyKeys.PROP_NATIVE_LIB_PATH as File object.
    
    Returns:
    
    folder that contains all libraries
  - isHeaderUseHeuristics
```
public static boolean isHeaderUseHeuristics()
```
  - getDeLFTPath
```
public static java.lang.String getDeLFTPath()
```
    Returns the installation path of DeLFT if set, null otherwise. It is required for using a Deep Learning sequence labelling engine.
    
    Returns:
    
    folder that contains the local install of DeLFT
  - getDeLFTFilePath
```
public static java.lang.String getDeLFTFilePath()
```
  - isDeLFTRedirectOutput
```
public static boolean isDeLFTRedirectOutput()
```
  - getGluttonHost
```
public static java.lang.String getGluttonHost()
```
  - getGluttonPort
```
public static java.lang.Integer getGluttonPort()
```
  - useELMo
```
public static boolean useELMo()
```
  - getProxyHost
```
public static java.lang.String getProxyHost()
```
    Returns the host for a proxy connection, given in the grobid-property file.
    
    Returns:
    
    host for connecting crossref
  - setProxyHost
```
public static void setProxyHost(java.lang.String host)
```
    Sets the host a proxy connection, given in the grobid-property file.
    
    Parameters:
    
    host - for connecting crossref
  - getProxyPort
```
public static java.lang.Integer getProxyPort()
```
    Returns the port for a proxy connection, given in the grobid-property file.
    
    Returns:
    
    port for connecting crossref
  - setCrossrefMailto
```
public static void setCrossrefMailto(java.lang.String mailto)
```
    Set the "mailto" parameter to be used in the crossref query and in User-Agent header, as recommended by CrossRef REST API documentation.
    
    Parameters:
    
    mailto - email parameter to be used for requesting crossref
  - getCrossrefMailto
```
public static java.lang.String getCrossrefMailto()
```
    Get the "mailto" parameter to be used in the crossref query and in User-Agent header, as recommended by CrossRef REST API documentation.
    
    Returns:
    
    string of the email parameter to be used for requesting crossref
  - setCrossrefToken
```
public static void setCrossrefToken(java.lang.String token)
```
    Set the Crossref Metadata Plus authorization token to be used for Crossref requests for the subscribers of this service. This token will ensure that said requests get directed to a pool of machines that are reserved for "Plus" SLA users.
    
    Parameters:
    
    token - authorization token to be used for requesting crossref
  - getCrossrefToken
```
public static java.lang.String getCrossrefToken()
```
    Get the Crossref Metadata Plus authorization token to be used for Crossref requests for the subscribers of this service. This token will ensure that said requests get directed to a pool of machines that are reserved for "Plus" SLA users.
    
    Returns:
    
    authorization token to be used for requesting crossref
  - setProxyPort
```
public static void setProxyPort(java.lang.String port)
```
    Sets the port for a proxy connection, given in the grobid-property file.
    
    Parameters:
    
    port - for connecting crossref
  - getPdfToXMLMemoryLimitMb
```
public static java.lang.Integer getPdfToXMLMemoryLimitMb()
```
  - getPdfToXMLTimeoutMs
```
public static java.lang.Integer getPdfToXMLTimeoutMs()
```
  - getNBThreads
```
public static java.lang.Integer getNBThreads()
```
    Returns the number of threads, given in the grobid-property file.
    
    Returns:
    
    number of threads
  - getPdfBlocksMax
```
public static java.lang.Integer getPdfBlocksMax()
```
  - getPdfTokensMax
```
public static java.lang.Integer getPdfTokensMax()
```
  - setNBThreads
```
public static void setNBThreads(java.lang.String nbThreads)
```
    Sets the number of threads, given in the grobid-property file.
    
    Parameters:
    
    nbThreads - umber of threads
  - isUseLanguageId
```
public static java.lang.Boolean isUseLanguageId()
```
    Returns if a language id shall be used, given in the grobid-property file.
    
    Returns:
    
    true if a language id shall be used
  - getLanguageDetectorFactory
```
public static java.lang.String getLanguageDetectorFactory()
```
  - setUseLanguageId
```
public static void setUseLanguageId(java.lang.String useLanguageId)
```
    Sets if a language id shall be used, given in the grobid-property file.
    
    Parameters:
    
    useLanguageId - true, if a language id shall be used
  - isResourcesInHome
```
public static java.lang.Boolean isResourcesInHome()
```
    Returns if resources like firstnames, lastnames and countries are supposed to be read from grobid-home folder, given in the grobid-property file.
    
    Returns:
    
    true if a language id shall be used
  - setResourcesInHome
```
public static void setResourcesInHome(java.lang.String resourceInHome)
```
    Sets if resources like firstnames, lastnames and countries are supposed to be read from grobid-home folder, given in the grobid-property file.
    
    Parameters:
    
    resourceInHome - true, if a language id shall be used
  - loadPdf2XMLPath
```
public static void loadPdf2XMLPath()
```
    Returns the path to the home folder of pdf to xml converter.
  - getPdfToXMLPath
```
public static java.io.File getPdfToXMLPath()
```
    Returns the path to the home folder of pdf to xml program.
    
    Returns:
    
    path to pdf to xml program
  - getGrobidCRFEngine
```
public static GrobidCRFEngine getGrobidCRFEngine()
```
  - getModelPath
```
public static java.io.File getModelPath(GrobidModel model)
```
  - getModelPath
```
public static java.io.File getModelPath()
```
  - getTemplatePath
```
public static java.io.File getTemplatePath(java.io.File resourcesDir,
                                           GrobidModel model)
```
  - getEvalCorpusPath
```
public static java.io.File getEvalCorpusPath(java.io.File resourcesDir,
                                             GrobidModel model)
```
  - getCorpusPath
```
public static java.io.File getCorpusPath(java.io.File resourcesDir,
                                         GrobidModel model)
```
  - getLexiconPath
```
public static java.lang.String getLexiconPath()
```
  - getLanguageDetectionResourcePath
```
public static java.io.File getLanguageDetectionResourcePath()
```
  - getMaxPoolConnections
```
public static int getMaxPoolConnections()
```
    Returns the maximum parallel connections allowed in the pool.
    
    Returns:
    
    the number of connections
  - getPoolMaxWait
```
public static int getPoolMaxWait()
```
    Returns maximum time to wait before timeout when the pool is full.
    
    Returns:
    
    time to wait in milliseconds.
  - getConsolidationService
```
public static Consolidation.GrobidConsolidationService getConsolidationService()
```
    Returns the consolidation service to be used.
    
    Returns:
    
    the consolidation service to be used
  - setConsolidationService
```
public static void setConsolidationService(java.lang.String service)
```
    Set which consolidation service to use
  - isContextExecutionServer
```
public static java.lang.Boolean isContextExecutionServer()
```
    Returns if the execution context is stand alone or server.
    
    Returns:
    
    the context of execution. Return false if the property value is not readable.
  - setContextExecutionServer
```
public static void setContextExecutionServer(java.lang.Boolean state)
```
    Set if the execution context is stand alone or server.
    
    Parameters:
    
    state - true to set the context of execution to server, false else.
  - setVersion
```
public static void setVersion(java.lang.String version)
```
    Sets the GROBID version.
  - getPythonVirtualEnv
```
public static java.lang.String getPythonVirtualEnv()
```
  - setPythonVirtualEnv
```
public static void setPythonVirtualEnv(java.lang.String pythonVirtualEnv)
```

Class GrobidProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

FILE_ENDING_TEI_HEADER

FILE_ENDING_TEI_FULLTEXT

Constructor Detail

GrobidProperties

Method Detail

reset

getInstance

getInstance

reload

getNewInstance

getProps

get_GROBID_HOME_PATH

getGrobidHomePath

set_GROBID_HOME_PATH

getGrobidPropertiesPath

setGrobidPropertiesPath

getPropertyValue

getPropertyValue

setPropertyValue

getVersion

getEnvironmentVariableOverrides

initializePaths

checkProperties

getTempPath

setNativeLibraryPath

getNativeLibraryPath

isHeaderUseHeuristics

getDeLFTPath

getDeLFTFilePath

isDeLFTRedirectOutput

getGluttonHost

getGluttonPort

useELMo

getProxyHost

setProxyHost

getProxyPort

setCrossrefMailto

getCrossrefMailto

setCrossrefToken

getCrossrefToken

setProxyPort

getPdfToXMLMemoryLimitMb

getPdfToXMLTimeoutMs

getNBThreads

getPdfBlocksMax

getPdfTokensMax

setNBThreads

isUseLanguageId

getLanguageDetectorFactory

setUseLanguageId

isResourcesInHome

setResourcesInHome

loadPdf2XMLPath

getPdfToXMLPath

getGrobidCRFEngine

getModelPath

getModelPath

getTemplatePath

getEvalCorpusPath

getCorpusPath

getLexiconPath

getLanguageDetectionResourcePath

getMaxPoolConnections

getPoolMaxWait

getConsolidationService

setConsolidationService

isContextExecutionServer

setContextExecutionServer

setVersion

getPythonVirtualEnv

setPythonVirtualEnv