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

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

public class MetaData
extends java.lang.Object

This is the Save Information Java object class. It includes VTT file format version, user name, and time stamp.

History:

• SCR-98, chlu, 02-02-10, add who/when/file format to VTT file.

Version:

V-2010

Author:

NLM NLS Development Team, clu

Field Summary

static java.lang.String	FILE_SAVE_STR
static java.lang.String	TAGS_FILE_STR

Constructor Summary

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

Method Summary

void	AddSaveInfo(SaveInfo saveInfo) Add SaveInfo object to saveInfos_.
boolean	GetConfirmation() Get the flag of confirmation.
java.lang.String	GetFileHistoryStr(boolean headerFlag) Convert file history to string representation: header + file history
java.util.Vector<SaveInfo>	GetSaveInfos() Get SaveInfos
java.lang.String	GetTagsFile() Get default tags file.
void	ReadMetaDataFromLine(java.lang.String line) Read Meta data from a line with verbose options
void	ReadMetaDataFromLine(java.lang.String line, int verboseType) Read Meta data from a line with verbose options
void	Reset() Reset data member to init values.
void	SetConfirmation(boolean confirmation) Set the flag of confirmation.
void	SetTagsFile(java.lang.String tagsFile) Set default tags file.
java.lang.String	ToString(boolean headerFlag) Convert meta data to string representation: header + Meta-Data

Methods inherited from class java.lang.Object

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

Field Detail

TAGS_FILE_STR

public static final java.lang.String TAGS_FILE_STR

See Also:

Constant Field Values

FILE_SAVE_STR

public static final java.lang.String FILE_SAVE_STR

See Also:

Constant Field Values

Constructor Detail

MetaData

public MetaData()

Create a MetaData Java object with default values.

Method Detail

GetTagsFile

public java.lang.String GetTagsFile()

Get default tags file.

Returns:

the path of default tags file

GetConfirmation

public boolean GetConfirmation()

Get the flag of confirmation.

Returns:

the boolean value of confirmation flag

SetTagsFile

public void SetTagsFile(java.lang.String tagsFile)

Set default tags file.

Parameters:

tagsFile - path of default tags file

SetConfirmation

public void SetConfirmation(boolean confirmation)

Set the flag of confirmation.

Parameters:

confirmation - the boolean value of confirmation flag

GetSaveInfos

public java.util.Vector<SaveInfo> GetSaveInfos()

Get SaveInfos

Returns:

the save infos

ReadMetaDataFromLine

public void ReadMetaDataFromLine(java.lang.String line)

Read Meta data from a line with verbose options

Parameters:

line - a line represents meta data

ReadMetaDataFromLine

public void ReadMetaDataFromLine(java.lang.String line,
                                 int verboseType)

Read Meta data from a line with verbose options

Parameters:

line - a line represents meta data

verboseType - verbose types: VERVOSE_GUI and VERBOSE_STD_IO

AddSaveInfo

public void AddSaveInfo(SaveInfo saveInfo)

Add SaveInfo object to saveInfos_.

Parameters:

saveInfo - saveInfo to be added to meta data

Reset

public void Reset()

Reset data member to init values.

GetFileHistoryStr

public java.lang.String GetFileHistoryStr(boolean headerFlag)

Convert file history to string representation: header + file history

Parameters:

headerFlag - the boolean flag of showing header

Returns:

the string representation

ToString

public java.lang.String ToString(boolean headerFlag)

Convert meta data to string representation: header + Meta-Data

Parameters:

headerFlag - the boolean flag of showing header

Returns:

the string representation