org.corpus_tools.annis.gui

Class InstanceConfig

java.lang.Object

org.corpus_tools.annis.gui.InstanceConfig

All Implemented Interfaces:

Serializable

public class InstanceConfig
extends Object
implements Serializable

Hold information about the configuration of a specific (sub-) instance of ANNIS. Each physical installation (speak deployment) of ANNIS is able to have several instances which behave differently. This is meant to provide a more specialized presentation for different projects while still using only one ANNIS installation.

Author:

Thomas Krause <krauseto@hu-berlin.de>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InstanceConfig()

Method Summary

Modifier and Type	Method and Description
List<CorpusSet>	getCorpusSets() Get the corpus sets that are pre-defined by the instance.
String	getDefaultCorpusSet() Get the name of the corpus set that should be activated by default.
String	getDefaultQueryBuilder() Get the short name of the query builder that should be selected by default.
FontConfig	getFont() Get the special font used by this instance.
FontConfig	getFrequencyFont() Get a special font config that should be used in the frequency chart.
String	getHelpUrl() The URL to use for the internal help page.
String	getInstanceDisplayName() Get the external display name (used e.g. in the user interface) of this instance.
String	getInstanceName() Get the internal short name of this instance.
String	getKeyboardLayout() Default keyboard layout used for the virtual keyboard.
boolean	isLoginOnStart() If true the login window is shown at each startup automatically.
void	setCorpusSets(List<CorpusSet> corpusSets)
void	setDefaultCorpusSet(String defaultCorpusSet)
void	setDefaultQueryBuilder(String defaultQueryBuilder)
void	setFont(FontConfig font)
void	setFrequencyFont(FontConfig frequencyFont)
void	setHelpUrl(String helpUrl)
void	setInstanceDisplayName(String instanceDisplayName)
void	setInstanceName(String instanceName)
void	setKeyboardLayout(String keyboardLayout)
void	setLoginOnStart(boolean loginOnStart)

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceConfig

public InstanceConfig()

Method Detail

getCorpusSets

public List<CorpusSet> getCorpusSets()

Get the corpus sets that are pre-defined by the instance.

Returns:

getDefaultCorpusSet

public String getDefaultCorpusSet()

Get the name of the corpus set that should be activated by default.

Returns:

getDefaultQueryBuilder

public String getDefaultQueryBuilder()

Get the short name of the query builder that should be selected by default.

Returns:

getFont

public FontConfig getFont()

Get the special font used by this instance.

Returns:

getFrequencyFont

public FontConfig getFrequencyFont()

Get a special font config that should be used in the frequency chart. Might return null, in this case you should use the default font from getFont().

Returns:

getHelpUrl

public String getHelpUrl()

The URL to use for the internal help page. Must be located under the same domain as the ANNIS interface.

Returns:

getInstanceDisplayName

public String getInstanceDisplayName()

Get the external display name (used e.g. in the user interface) of this instance.

Returns:

getInstanceName

public String getInstanceName()

Get the internal short name of this instance.

Returns:

getKeyboardLayout

public String getKeyboardLayout()

Default keyboard layout used for the virtual keyboard. Do not set null to disable virtual keyboards.

Returns:

isLoginOnStart

public boolean isLoginOnStart()

If true the login window is shown at each startup automatically.

Returns:

setCorpusSets

public void setCorpusSets(List<CorpusSet> corpusSets)

Parameters:

corpusSets -

See Also:

getCorpusSets()

setDefaultCorpusSet

public void setDefaultCorpusSet(String defaultCorpusSet)

Parameters:

defaultCorpusSet -

See Also:

getDefaultCorpusSet()

setDefaultQueryBuilder

public void setDefaultQueryBuilder(String defaultQueryBuilder)

Parameters:

defaultQueryBuilder -

See Also:

getDefaultQueryBuilder()

setFont

public void setFont(FontConfig font)

Parameters:

font -

See Also:

getFont()

setFrequencyFont

public void setFrequencyFont(FontConfig frequencyFont)

Parameters:

frequencyFont -

See Also:

getFrequencyFont()

setHelpUrl

public void setHelpUrl(String helpUrl)

setInstanceDisplayName

public void setInstanceDisplayName(String instanceDisplayName)

Parameters:

instanceDisplayName -

See Also:

getInstanceDisplayName()

setInstanceName

public void setInstanceName(String instanceName)

Parameters:

instanceName -

See Also:

getInstanceName()

setKeyboardLayout

public void setKeyboardLayout(String keyboardLayout)

Parameters:

keyboardLayout -

See Also:

getKeyboardLayout()

setLoginOnStart

public void setLoginOnStart(boolean loginOnStart)

Parameters:

loginOnStart -

See Also:

isLoginOnStart()