gov.nih.nlm.nls.vtt.Model
Class ConfigObj

java.lang.Object
  gov.nih.nlm.nls.vtt.Model.ConfigObj

public class ConfigObj
extends java.lang.Object

This class provides the Java object for configured variables.

History:

• SCR-96, chlu, 02/01/10, add Username to VTT config file

Version:

V-2010

Author:

NLM NLS Development Team, clu

Constructor Summary

ConfigObj()
Create a ConfigObj Java object with default values.

ConfigObj(ConfigObj configObj)
Create a ConfigObj Java object by specifying a ConfigObj object.

ConfigObj(Configuration conf)
Create a ConfigObj Java object by specifying a configuration object.

Method Summary

int	GetBaseFontSize() Get configuration variables: the base font size.
java.io.File	GetDocDir() Get configuration variables: VTT documents directory.
int	GetFilePathDisplayLength() Get configuration variables: the display length of file path.
int	GetLengthSize() Get configuration variables: the size of field for length.
int	GetOffsetSize() Get configuration variables: the size of field for offset.
Tag	GetSelectMarkupTag() Get configuration variables: the tag for the selected markup.
int	GetTagCategorySize() Get configuration variables: the size of field for tag category.
java.io.File	GetTagFile() Get configuration variables: VTT documents directory.
int	GetTagNameSize() Get configuration variables: the size of field for tag name.
java.lang.String	GetUserName() Get configuration variables: VTT user name.
java.lang.String	GetVttDir() Get configuration variables: VTT top directory.
int	GetVttFormat() Get configuration variables: VTT format.
int	GetZoomFactor() Get configuration variables: the zoom in/out factor.
boolean	IsOverwriteSelectBackgroundColor() Get configuration variables: the boolean flag of overwriting background color on select markup.
boolean	IsOverwriteSelectBold() Get configuration variables: the boolean flag of overwriting bold on select markup.
boolean	IsOverwriteSelectFont() Get configuration variables: the boolean flag of overwriting font on select markup.
boolean	IsOverwriteSelectItalic() Get configuration variables: the boolean flag of overwriting italic on select markup.
boolean	IsOverwriteSelectSize() Get configuration variables: the boolean flag of overwriting size on select markup.
boolean	IsOverwriteSelectTextColor() Get configuration variables: the boolean flag of overwriting text color on select markup.
boolean	IsOverwriteSelectUnderline() Get configuration variables: the boolean flag of overwriting underline on select markup.
boolean	IsUseTextTagForNotDisplaySelectMarkup() Get configuration variables: the boolean flag of use text tag for not display select markup.
static void	SaveFile(java.io.File configFile, ConfigObj configObj) Save configObj to file.
void	SetBaseFontSize(int baseFontSize) Set configuration variables: the base font size.
void	SetDocDir(java.io.File docDir) Set configuration variables: VTT documents directory.
void	SetFilePathDisplayLength(int filePathDisplayLength) Set configuration variables: the display length of file path.
void	SetLengthSize(int lengthSize) Set configuration variables: the size of field for length.
void	SetOffsetSize(int offsetSize) Set configuration variables: the size of field for offset.
void	SetOverwriteSelectBackgroundColor(boolean overwriteSelectBackgroundColor) Set configuration variables: the boolean flag of overwriting background color on select markup.
void	SetOverwriteSelectBold(boolean overwriteSelectBold) Set configuration variables: the boolean flag of overwriting bold on select markup.
void	SetOverwriteSelectFont(boolean overwriteSelectFont) Set configuration variables: the boolean flag of overwriting font on select markup.
void	SetOverwriteSelectItalic(boolean overwriteSelectItalic) Set configuration variables: the boolean flag of overwriting italic on select markup.
void	SetOverwriteSelectSize(boolean overwriteSelectSize) Set configuration variables: the boolean flag of overwriting size on select markup.
void	SetOverwriteSelectTextColor(boolean overwriteSelectTextColor) Set configuration variables: the boolean flag of overwriting text color on select markup.
void	SetOverwriteSelectUnderline(boolean overwriteSelectUnderline) Set configuration variables: the boolean flag of overwriting underline on select markup.
void	SetSelectMarkupTag(Tag selectMarkupTag) Set configuration variables: the tag for the selected markup
void	SetTagCategorySize(int tagCategorySize) Set configuration variables: the size of field for tag category.
void	SetTagFile(java.io.File tagFile) Set configuration variables: VTT Tag file.
void	SetTagNameSize(int tagNameSize) Set configuration variables: the size of field for tag name.
void	SetUserName(java.lang.String userName) Set configuration variables: VTT user name.
void	SetUseTextTagForNotDisplaySelectMarkup(boolean useTextTagForNotDisplaySelectMarkup) Set configuration variables: the boolean flag of use text tag for not display select markup.
void	SetVarsFromConfig(Configuration conf) Set configuration variables by specifying a Configuration object.
void	SetVarsFromConfigObj(ConfigObj configObj) Set configuration variables by specifying a ConfigObj object.
void	SetVttDir(java.lang.String vttDir) Set configuration variables: VTT top directory.
void	SetVttFormat(int vttFormat) Set configuration variables: VTT format.
void	SetZoomFactor(int zoomFactor) Set configuration variables: the zoom in/out factor.
java.lang.String	ToString() Convert the configObj to String

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigObj

public ConfigObj()

Create a ConfigObj Java object with default values.

ConfigObj

public ConfigObj(Configuration conf)

Create a ConfigObj Java object by specifying a configuration object.

Parameters:

conf - the configuration object

ConfigObj

public ConfigObj(ConfigObj configObj)

Create a ConfigObj Java object by specifying a ConfigObj object.

Parameters:

configObj - the ConfigObj object

Method Detail

SetVarsFromConfigObj

public void SetVarsFromConfigObj(ConfigObj configObj)

Set configuration variables by specifying a ConfigObj object.

Parameters:

configObj - the ConfigObj object

SetVarsFromConfig

public void SetVarsFromConfig(Configuration conf)

Set configuration variables by specifying a Configuration object.

Parameters:

conf - the Configuration object

SetVttDir

public void SetVttDir(java.lang.String vttDir)

Set configuration variables: VTT top directory.

Parameters:

vttDir - the absolute path of VTT top directory

SetDocDir

public void SetDocDir(java.io.File docDir)

Set configuration variables: VTT documents directory.

Parameters:

docDir - the absolute path of VTT documents directory

SetTagFile

public void SetTagFile(java.io.File tagFile)

Set configuration variables: VTT Tag file.

Parameters:

tagFile - the absolute path of VTT Tag file

SetUserName

public void SetUserName(java.lang.String userName)

Set configuration variables: VTT user name.

Parameters:

userName - the VTT user name

SetVttFormat

public void SetVttFormat(int vttFormat)

Set configuration variables: VTT format. There are four VTT format:

• SIMPLE_FORMAT: not align
• READABLE_FORMAT: align with auto length
• FIX_LENGTH_FORMAT: align with fixed length
• SIMPLEST_FORMAT: no header, no annotation

Parameters:

vttFormat - the VTT format

SetFilePathDisplayLength

public void SetFilePathDisplayLength(int filePathDisplayLength)

Set configuration variables: the display length of file path.

Parameters:

filePathDisplayLength - the display length of file path

SetBaseFontSize

public void SetBaseFontSize(int baseFontSize)

Set configuration variables: the base font size.

Parameters:

baseFontSize - the base font size

SetZoomFactor

public void SetZoomFactor(int zoomFactor)

Set configuration variables: the zoom in/out factor.

Parameters:

zoomFactor - the zoom factor

SetOffsetSize

public void SetOffsetSize(int offsetSize)

Set configuration variables: the size of field for offset.

Parameters:

offsetSize - the size of field for offset

SetLengthSize

public void SetLengthSize(int lengthSize)

Set configuration variables: the size of field for length.

Parameters:

lengthSize - the size of field for length

SetTagNameSize

public void SetTagNameSize(int tagNameSize)

Set configuration variables: the size of field for tag name.

Parameters:

tagNameSize - the size of field for tag name

SetTagCategorySize

public void SetTagCategorySize(int tagCategorySize)

Set configuration variables: the size of field for tag category.

Parameters:

tagCategorySize - the size of field for tag category

SetUseTextTagForNotDisplaySelectMarkup

public void SetUseTextTagForNotDisplaySelectMarkup(boolean useTextTagForNotDisplaySelectMarkup)

Set configuration variables: the boolean flag of use text tag for not display select markup.

Parameters:

useTextTagForNotDisplaySelectMarkup - the boolean flag of use text tag for not display select markup

SetOverwriteSelectBold

public void SetOverwriteSelectBold(boolean overwriteSelectBold)

Set configuration variables: the boolean flag of overwriting bold on select markup.

Parameters:

overwriteSelectBold - the boolean flag of overwriting bold on select markup

SetOverwriteSelectItalic

public void SetOverwriteSelectItalic(boolean overwriteSelectItalic)

Set configuration variables: the boolean flag of overwriting italic on select markup.

Parameters:

overwriteSelectItalic - the boolean flag of overwriting italic on select markup

SetOverwriteSelectUnderline

public void SetOverwriteSelectUnderline(boolean overwriteSelectUnderline)

Set configuration variables: the boolean flag of overwriting underline on select markup.

Parameters:

overwriteSelectUnderline - the boolean flag of overwriting underline on select markup

SetOverwriteSelectFont

public void SetOverwriteSelectFont(boolean overwriteSelectFont)

Set configuration variables: the boolean flag of overwriting font on select markup.

Parameters:

overwriteSelectFont - the boolean flag of overwriting font on select markup

SetOverwriteSelectSize

public void SetOverwriteSelectSize(boolean overwriteSelectSize)

Set configuration variables: the boolean flag of overwriting size on select markup.

Parameters:

overwriteSelectSize - the boolean flag of overwriting size on select markup

SetOverwriteSelectTextColor

public void SetOverwriteSelectTextColor(boolean overwriteSelectTextColor)

Set configuration variables: the boolean flag of overwriting text color on select markup.

Parameters:

overwriteSelectTextColor - the boolean flag of overwriting text color on select markup

SetOverwriteSelectBackgroundColor

public void SetOverwriteSelectBackgroundColor(boolean overwriteSelectBackgroundColor)

Set configuration variables: the boolean flag of overwriting background color on select markup.

Parameters:

overwriteSelectBackgroundColor - the boolean flag of overwriting background color on select markup

SetSelectMarkupTag

public void SetSelectMarkupTag(Tag selectMarkupTag)

Set configuration variables: the tag for the selected markup

Parameters:

selectMarkupTag - the tag for the selected markup

GetVttDir

public java.lang.String GetVttDir()

Get configuration variables: VTT top directory.

Returns:

the absolute path of VTT top directory

GetDocDir

public java.io.File GetDocDir()

Get configuration variables: VTT documents directory.

Returns:

the File object of VTT documents directory

GetTagFile

public java.io.File GetTagFile()

Get configuration variables: VTT documents directory.

Returns:

the Fiel object of VTT Tag file

GetUserName

public java.lang.String GetUserName()

Get configuration variables: VTT user name.

Returns:

the absolute path of VTT user name

GetVttFormat

public int GetVttFormat()

Get configuration variables: VTT format.

Returns:

the VTT format

GetFilePathDisplayLength

public int GetFilePathDisplayLength()

Get configuration variables: the display length of file path.

Returns:

the display length of file path

GetBaseFontSize

public int GetBaseFontSize()

Get configuration variables: the base font size.

Returns:

the base font size

GetZoomFactor

public int GetZoomFactor()

Get configuration variables: the zoom in/out factor.

Returns:

the zoom in/out factor

GetOffsetSize

public int GetOffsetSize()

Get configuration variables: the size of field for offset.

Returns:

the size of field for offset

GetLengthSize

public int GetLengthSize()

Get configuration variables: the size of field for length.

Returns:

the size of field for length

GetTagNameSize

public int GetTagNameSize()

Get configuration variables: the size of field for tag name.

Returns:

the size of field for tag name

GetTagCategorySize

public int GetTagCategorySize()

Get configuration variables: the size of field for tag category.

Returns:

the size of field for tag category

IsUseTextTagForNotDisplaySelectMarkup

public boolean IsUseTextTagForNotDisplaySelectMarkup()

Get configuration variables: the boolean flag of use text tag for not display select markup.

Returns:

the boolean flag of use text tag for not display select markup

IsOverwriteSelectBold

public boolean IsOverwriteSelectBold()

Get configuration variables: the boolean flag of overwriting bold on select markup.

Returns:

the boolean flag of overwriting bold on select markup

IsOverwriteSelectItalic

public boolean IsOverwriteSelectItalic()

Get configuration variables: the boolean flag of overwriting italic on select markup.

Returns:

the boolean flag of overwriting italic on select markup

IsOverwriteSelectUnderline

public boolean IsOverwriteSelectUnderline()

Get configuration variables: the boolean flag of overwriting underline on select markup.

Returns:

the boolean flag of overwriting underline on select markup

IsOverwriteSelectFont

public boolean IsOverwriteSelectFont()

Get configuration variables: the boolean flag of overwriting font on select markup.

Returns:

the boolean flag of overwriting font on select markup

IsOverwriteSelectSize

public boolean IsOverwriteSelectSize()

Get configuration variables: the boolean flag of overwriting size on select markup.

Returns:

the boolean flag of overwriting size on select markup

IsOverwriteSelectTextColor

public boolean IsOverwriteSelectTextColor()

Get configuration variables: the boolean flag of overwriting text color on select markup.

Returns:

the boolean flag of overwriting italic on text color markup

IsOverwriteSelectBackgroundColor

public boolean IsOverwriteSelectBackgroundColor()

Get configuration variables: the boolean flag of overwriting background color on select markup.

Returns:

the boolean flag of overwriting background color on select markup

GetSelectMarkupTag

public Tag GetSelectMarkupTag()

Get configuration variables: the tag for the selected markup.

Returns:

the tag for the selected markup

SaveFile

public static void SaveFile(java.io.File configFile,
                            ConfigObj configObj)

Save configObj to file.

Parameters:

configFile - the config file to save to

configObj - the configObj object to be saved

ToString

public java.lang.String ToString()

Convert the configObj to String

Returns:

the string format of this configObj