org.maltparser.core.config

Class ConfigurationDir

java.lang.Object

org.maltparser.core.config.ConfigurationDir

public class ConfigurationDir
extends java.lang.Object

This class contains methods for handle the configuration directory.

Author:

Johan Hall

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BUFFER
protected java.io.File	configDirectory
protected int	containerIndex
protected java.lang.String	createdByMaltParserVersion
protected java.io.BufferedWriter	infoFile
protected java.lang.String	name
protected java.lang.String	type
protected java.net.URL	url
protected java.io.File	workingDirectory

Constructor Summary

Constructors

Constructor and Description
ConfigurationDir(java.lang.String name, java.lang.String type, int containerIndex) Creates a new configuration directory or a configuration directory from a mco-file
ConfigurationDir(java.net.URL url) Creates a configuration directory from a mco-file specified by an URL.

Method Summary

Modifier and Type	Method and Description
boolean	addDataFormatInstance(java.lang.String key, DataFormatInstance dataFormatInstance)
protected void	checkConfigDirectory()
protected void	checkNConvertConfigVersion()
void	copyConfigFile(java.io.File in, java.io.File out, Versioning versioning)
java.lang.String	copyToConfig(java.io.File source) Copies a file into the configuration directory.
java.lang.String	copyToConfig(java.lang.String fileUrl)
java.lang.String	copyToConfig(java.net.URL url)
void	createConfigDirectory() Creates the configuration directory
void	createConfigFile() Creates the malt configuration file (.mco).
protected void	createInfoFile()
void	deleteConfigDirectory() Removes the configuration directory, if it exists and it contains a .info file.
void	echoInfoFile() Prints the content of the configuration information file to the system logger
protected void	finalize()
java.io.OutputStreamWriter	getAppendOutputStreamWriter(java.lang.String fileName) This method acts the same as getOutputStreamWriter with the difference that the writer append in the file if it already exists instead of deleting the previous content before starting to write.
java.io.File	getConfigDirectory() Returns a file handler object for the configuration directory
java.util.jar.JarEntry	getConfigFileEntry(java.lang.String fileName)
java.net.URL	getConfigFileEntryURL(java.lang.String fileName)
java.util.jar.JarFile	getConfigJarfile()
int	getContainerIndex() Returns the option container index
java.lang.String	getCreatedByMaltParserVersion() Returns the version number of MaltParser which created the malt configuration file (.mco)
DataFormatInstance	getDataFormatInstance(java.lang.String key)
java.util.Set<java.lang.String>	getDataFormatInstanceKeys()
DataFormatManager	getDataFormatManager()
java.io.File	getFile(java.lang.String fileName) Returns a file handler object of a file within the configuration directory
java.io.BufferedWriter	getInfoFileWriter() Returns a writer to the configuration information file
DataFormatInstance	getInputDataFormatInstance()
java.net.URL	getInputFormatURL()
java.io.InputStream	getInputStreamFromConfigFileEntry(java.lang.String fileName)
java.io.InputStreamReader	getInputStreamReader(java.lang.String fileName) Creates an input stream reader for reading a file within the configuration directory.
java.io.InputStreamReader	getInputStreamReader(java.lang.String fileName, java.lang.String charSet) Creates an input stream reader for reading a file within the configuration directory
java.io.InputStreamReader	getInputStreamReaderFromConfigFile(java.lang.String fileName)
java.io.InputStreamReader	getInputStreamReaderFromConfigFileEntry(java.lang.String fileName, java.lang.String charSet)
java.lang.String	getName() Returns the name of the configuration directory
java.net.URL	getOutputFormatURL()
java.io.OutputStreamWriter	getOutputStreamWriter(java.lang.String fileName) Creates an output stream writer, where the corresponding file will be included in the configuration directory.
java.io.OutputStreamWriter	getOutputStreamWriter(java.lang.String fileName, java.lang.String charSet) Creates an output stream writer, where the corresponding file will be included in the configuration directory
SymbolTableHandler	getSymbolTables()
java.lang.String	getType() Returns the type of the configuration directory
java.net.URL	getUrl() Returns the URL to the malt configuration file (.mco)
java.io.File	getWorkingDirectory() Returns a file handler object for the working directory
void	initCreatedByMaltParserVersionFromInfoFile()
void	initDataFormat()
protected void	initNameNTypeFromInfoFile(java.net.URL url)
void	initWorkingDirectory() Initialize the working directory
void	initWorkingDirectory(java.lang.String pathPrefixString) Initialize the working directory according to the path.
protected void	setConfigDirectory(java.io.File dir)
void	setContainerIndex(int containerIndex) Sets the option container index
void	setCreatedByMaltParserVersion(java.lang.String createdByMaltParserVersion) Sets the version number of MaltParser which created the malt configuration file (.mco)
void	setDataFormatManager(DataFormatManager dataFormatManager)
protected void	setName(java.lang.String name)
void	setSymbolTables(SymbolTableHandler symbolTables)
protected void	setType(java.lang.String type)
protected void	setUrl(java.net.URL url)
int	sizeDataFormatInstance()
void	terminate() Terminates the configuration directory
void	unpackConfigFile() Unpacks the malt configuration file (.mco).
protected void	unpackConfigFile(java.util.jar.JarInputStream jis)
void	versioning()

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER

protected static final int BUFFER

See Also:

Constant Field Values

configDirectory

protected java.io.File configDirectory

name

protected java.lang.String name

type

protected java.lang.String type

workingDirectory

protected java.io.File workingDirectory

url

protected java.net.URL url

containerIndex

protected int containerIndex

infoFile

protected java.io.BufferedWriter infoFile

createdByMaltParserVersion

protected java.lang.String createdByMaltParserVersion

Constructor Detail

ConfigurationDir

public ConfigurationDir(java.net.URL url)
                 throws MaltChainedException

Creates a configuration directory from a mco-file specified by an URL.

Parameters:

url - an URL to a mco-file

Throws:

MaltChainedException

ConfigurationDir

public ConfigurationDir(java.lang.String name,
                        java.lang.String type,
                        int containerIndex)
                 throws MaltChainedException

Creates a new configuration directory or a configuration directory from a mco-file

Parameters:

name - the name of the configuration

type - the type of configuration

containerIndex - the container index

Throws:

MaltChainedException

Method Detail

initDataFormat

public void initDataFormat()
                    throws MaltChainedException

Throws:

MaltChainedException

getOutputStreamWriter

public java.io.OutputStreamWriter getOutputStreamWriter(java.lang.String fileName,
                                                        java.lang.String charSet)
                                                 throws MaltChainedException

Creates an output stream writer, where the corresponding file will be included in the configuration directory

Parameters:

fileName - a file name

charSet - a char set

Returns:

an output stream writer for writing to a file within the configuration directory

Throws:

MaltChainedException

getOutputStreamWriter

public java.io.OutputStreamWriter getOutputStreamWriter(java.lang.String fileName)
                                                 throws MaltChainedException

Creates an output stream writer, where the corresponding file will be included in the configuration directory. Uses UTF-8 for character encoding.

Parameters:

fileName - a file name

Returns:

an output stream writer for writing to a file within the configuration directory

Throws:

MaltChainedException

getAppendOutputStreamWriter

public java.io.OutputStreamWriter getAppendOutputStreamWriter(java.lang.String fileName)
                                                       throws MaltChainedException

This method acts the same as getOutputStreamWriter with the difference that the writer append in the file if it already exists instead of deleting the previous content before starting to write.

Parameters:

fileName - a file name

Returns:

an output stream writer for writing to a file within the configuration directory

Throws:

MaltChainedException

getInputStreamReader

public java.io.InputStreamReader getInputStreamReader(java.lang.String fileName,
                                                      java.lang.String charSet)
                                               throws MaltChainedException

Creates an input stream reader for reading a file within the configuration directory

Parameters:

fileName - a file name

charSet - a char set

Returns:

an input stream reader for reading a file within the configuration directory

Throws:

MaltChainedException

getInputStreamReader

public java.io.InputStreamReader getInputStreamReader(java.lang.String fileName)
                                               throws MaltChainedException

Creates an input stream reader for reading a file within the configuration directory. Uses UTF-8 for character encoding.

Parameters:

fileName - a file name

Returns:

an input stream reader for reading a file within the configuration directory

Throws:

MaltChainedException

getConfigJarfile

public java.util.jar.JarFile getConfigJarfile()
                                       throws MaltChainedException

Throws:

MaltChainedException

getConfigFileEntry

public java.util.jar.JarEntry getConfigFileEntry(java.lang.String fileName)
                                          throws MaltChainedException

Throws:

MaltChainedException

getInputStreamFromConfigFileEntry

public java.io.InputStream getInputStreamFromConfigFileEntry(java.lang.String fileName)
                                                      throws MaltChainedException

Throws:

MaltChainedException

getInputStreamReaderFromConfigFileEntry

public java.io.InputStreamReader getInputStreamReaderFromConfigFileEntry(java.lang.String fileName,
                                                                         java.lang.String charSet)
                                                                  throws MaltChainedException

Throws:

MaltChainedException

getInputStreamReaderFromConfigFile

public java.io.InputStreamReader getInputStreamReaderFromConfigFile(java.lang.String fileName)
                                                             throws MaltChainedException

Throws:

MaltChainedException

getFile

public java.io.File getFile(java.lang.String fileName)
                     throws MaltChainedException

Returns a file handler object of a file within the configuration directory

Parameters:

fileName - a file name

Returns:

a file handler object of a file within the configuration directory

Throws:

MaltChainedException

getConfigFileEntryURL

public java.net.URL getConfigFileEntryURL(java.lang.String fileName)
                                   throws MaltChainedException

Throws:

MaltChainedException

copyToConfig

public java.lang.String copyToConfig(java.io.File source)
                              throws MaltChainedException

Copies a file into the configuration directory.

Parameters:

source - a path to file

Throws:

MaltChainedException

copyToConfig

public java.lang.String copyToConfig(java.lang.String fileUrl)
                              throws MaltChainedException

Throws:

MaltChainedException

copyToConfig

public java.lang.String copyToConfig(java.net.URL url)
                              throws MaltChainedException

Throws:

MaltChainedException

deleteConfigDirectory

public void deleteConfigDirectory()
                           throws MaltChainedException

Removes the configuration directory, if it exists and it contains a .info file.

Throws:

MaltChainedException

getConfigDirectory

public java.io.File getConfigDirectory()

Returns a file handler object for the configuration directory

Returns:

a file handler object for the configuration directory

setConfigDirectory

protected void setConfigDirectory(java.io.File dir)

createConfigDirectory

public void createConfigDirectory()
                           throws MaltChainedException

Creates the configuration directory

Throws:

MaltChainedException

checkConfigDirectory

protected void checkConfigDirectory()
                             throws MaltChainedException

Throws:

MaltChainedException

createInfoFile

protected void createInfoFile()
                       throws MaltChainedException

Throws:

MaltChainedException

getInfoFileWriter

public java.io.BufferedWriter getInfoFileWriter()
                                         throws MaltChainedException

Returns a writer to the configuration information file

Returns:

a writer to the configuration information file

Throws:

MaltChainedException

createConfigFile

public void createConfigFile()
                      throws MaltChainedException

Creates the malt configuration file (.mco). This file is compressed.

Throws:

MaltChainedException

copyConfigFile

public void copyConfigFile(java.io.File in,
                           java.io.File out,
                           Versioning versioning)
                    throws MaltChainedException

Throws:

MaltChainedException

initNameNTypeFromInfoFile

protected void initNameNTypeFromInfoFile(java.net.URL url)
                                  throws MaltChainedException

Throws:

MaltChainedException

echoInfoFile

public void echoInfoFile()
                  throws MaltChainedException

Prints the content of the configuration information file to the system logger

Throws:

MaltChainedException

unpackConfigFile

public void unpackConfigFile()
                      throws MaltChainedException

Unpacks the malt configuration file (.mco).

Throws:

MaltChainedException

unpackConfigFile

protected void unpackConfigFile(java.util.jar.JarInputStream jis)
                         throws MaltChainedException

Throws:

MaltChainedException

getName

public java.lang.String getName()

Returns the name of the configuration directory

Returns:

the name of the configuration directory

setName

protected void setName(java.lang.String name)

getType

public java.lang.String getType()

Returns the type of the configuration directory

Returns:

the type of the configuration directory

setType

protected void setType(java.lang.String type)

getWorkingDirectory

public java.io.File getWorkingDirectory()

Returns a file handler object for the working directory

Returns:

a file handler object for the working directory

initWorkingDirectory

public void initWorkingDirectory()
                          throws MaltChainedException

Initialize the working directory

Throws:

MaltChainedException

initWorkingDirectory

public void initWorkingDirectory(java.lang.String pathPrefixString)
                          throws MaltChainedException

Initialize the working directory according to the path. If the path is equals to "user.dir" or current directory, then the current directory will be the working directory.

Parameters:

pathPrefixString - the path to the working directory

Throws:

MaltChainedException

getUrl

public java.net.URL getUrl()

Returns the URL to the malt configuration file (.mco)

Returns:

the URL to the malt configuration file (.mco)

setUrl

protected void setUrl(java.net.URL url)

getContainerIndex

public int getContainerIndex()

Returns the option container index

Returns:

the option container index

setContainerIndex

public void setContainerIndex(int containerIndex)

Sets the option container index

Parameters:

containerIndex - a option container index

getCreatedByMaltParserVersion

public java.lang.String getCreatedByMaltParserVersion()

Returns the version number of MaltParser which created the malt configuration file (.mco)

Returns:

the version number of MaltParser which created the malt configuration file (.mco)

setCreatedByMaltParserVersion

public void setCreatedByMaltParserVersion(java.lang.String createdByMaltParserVersion)

Sets the version number of MaltParser which created the malt configuration file (.mco)

Parameters:

createdByMaltParserVersion - a version number of MaltParser

initCreatedByMaltParserVersionFromInfoFile

public void initCreatedByMaltParserVersionFromInfoFile()
                                                throws MaltChainedException

Throws:

MaltChainedException

versioning

public void versioning()
                throws MaltChainedException

Throws:

MaltChainedException

checkNConvertConfigVersion

protected void checkNConvertConfigVersion()
                                   throws MaltChainedException

Throws:

MaltChainedException

terminate

public void terminate()
               throws MaltChainedException

Terminates the configuration directory

Throws:

MaltChainedException

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getSymbolTables

public SymbolTableHandler getSymbolTables()

setSymbolTables

public void setSymbolTables(SymbolTableHandler symbolTables)

getDataFormatManager

public DataFormatManager getDataFormatManager()

setDataFormatManager

public void setDataFormatManager(DataFormatManager dataFormatManager)

getDataFormatInstanceKeys

public java.util.Set<java.lang.String> getDataFormatInstanceKeys()

addDataFormatInstance

public boolean addDataFormatInstance(java.lang.String key,
                                     DataFormatInstance dataFormatInstance)

getDataFormatInstance

public DataFormatInstance getDataFormatInstance(java.lang.String key)

sizeDataFormatInstance

public int sizeDataFormatInstance()

getInputDataFormatInstance

public DataFormatInstance getInputDataFormatInstance()

getInputFormatURL

public java.net.URL getInputFormatURL()

getOutputFormatURL

public java.net.URL getOutputFormatURL()