gov.nih.nlm.nls.lexAccess.Tools.GuiTool.Model

Class LaObj

java.lang.Object

gov.nih.nlm.nls.lexAccess.Tools.GuiTool.Model.LaObj

public class LaObj
extends java.lang.Object

This class defines LexAccess Object model.

History:

Version:

V-2016

Author:

NLM NLS Development Team, clu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASCII_STR
static int	MODE_BY_BASE
static int	MODE_BY_CATEGORY
static int	MODE_BY_TERM_EUI
static int	SOURCE_FILE
static int	SOURCE_SCREEN
static int	TYPE_ASCII
static int	TYPE_UTF8

Constructor Summary

Constructors

Constructor and Description
LaObj() Create a LaObj Java object with default values.

Method Summary

Modifier and Type	Method and Description
void	CleanUp() Clean up LexAccess API.
boolean	GetAppendToOutFile()
ConfigObj	GetConfigObj() Get LexAccess configuration object.
int	GetDataType()
java.lang.String	GetDataVersion()
java.lang.String	GetDbVersion()
java.lang.String	GetDefaultInFile()
java.lang.String	GetDefaultOutFile()
java.io.File	GetInFile()
int	GetInSource()
LexAccessApi	GetLexAccessApi() Get LexAccessApi object.
java.lang.String	GetLexAccessResultsByBase(java.lang.String inBase) Get LexAccess result by base.
java.lang.String	GetLexAccessResultsByCategory(long inCategory) Get LexAccess result by category.
java.lang.String	GetLexAccessResultsByTerm(java.lang.String inStr) Get LexAccess result by term/EUI.
int	GetLexRecordFormat()
boolean	GetNoOutputFlag()
java.io.File	GetOutFile()
long	GetOutFilterCategory()
int	GetOutSource()
int	GetSearchMode() Get search mode
java.lang.String	GetSeparator()
boolean	GetShowQuery()
boolean	GetShowTotalRecNum()
java.lang.String	GetVersionInfo() Get LexAccess version information.
void	ResetAllOptions()
boolean	ResetDbConnection()
void	SetAppendToOutFile(boolean appendToOutFile)
void	SetBaseBy(java.lang.String baseBy) Get search mode
void	SetDataType(int dataType)
void	SetDataVersion(java.lang.String dataVersion)
void	SetInFile(java.io.File inFile)
void	SetInSource(int inSource)
void	SetLexRecordFormat(int format)
void	SetNoOutputFlag(boolean noOutputFlag) Set no output flag
void	SetOutCategoryFilter(java.util.Vector<java.lang.Boolean> outCategoryValues)
void	SetOutFile(java.io.File outFile)
void	SetOutSource(int outSource)
void	SetSearchMode(int searchMode) Set search mode
void	SetSeparator(java.lang.String separator)
void	SetShowQuery(boolean showQuery)
void	SetShowTotalRecNum(boolean showTotalRecNum)

Methods inherited from class java.lang.Object

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

Field Detail

MODE_BY_TERM_EUI

public static final int MODE_BY_TERM_EUI

See Also:

Constant Field Values

MODE_BY_BASE

public static final int MODE_BY_BASE

See Also:

Constant Field Values

MODE_BY_CATEGORY

public static final int MODE_BY_CATEGORY

See Also:

Constant Field Values

SOURCE_SCREEN

public static final int SOURCE_SCREEN

See Also:

Constant Field Values

SOURCE_FILE

public static final int SOURCE_FILE

See Also:

Constant Field Values

TYPE_UTF8

public static final int TYPE_UTF8

See Also:

Constant Field Values

TYPE_ASCII

public static final int TYPE_ASCII

See Also:

Constant Field Values

ASCII_STR

public static final java.lang.String ASCII_STR

See Also:

Constant Field Values

Constructor Detail

LaObj

public LaObj()

Create a LaObj Java object with default values.

Method Detail

GetVersionInfo

public java.lang.String GetVersionInfo()

Get LexAccess version information.

Returns:

LexAccess version information

GetConfigObj

public ConfigObj GetConfigObj()

Get LexAccess configuration object.

Returns:

LexAccess configuration object

GetLexAccessApi

public LexAccessApi GetLexAccessApi()

Get LexAccessApi object.

Returns:

LexAccess API object

GetLexAccessResultsByTerm

public java.lang.String GetLexAccessResultsByTerm(java.lang.String inStr)

Get LexAccess result by term/EUI.

Parameters:

inStr - input in string format

Returns:

LexAccess result

GetLexAccessResultsByBase

public java.lang.String GetLexAccessResultsByBase(java.lang.String inBase)

Get LexAccess result by base.

Parameters:

inBase - input in base form

Returns:

LexAccess result

GetLexAccessResultsByCategory

public java.lang.String GetLexAccessResultsByCategory(long inCategory)

Get LexAccess result by category.

Parameters:

inCategory - in category

Returns:

LexAccess result

CleanUp

public void CleanUp()

Clean up LexAccess API.

GetSearchMode

public int GetSearchMode()

Get search mode

Returns:

search mode in Int format

SetSearchMode

public void SetSearchMode(int searchMode)

Set search mode

Parameters:

searchMode - search mode

SetBaseBy

public void SetBaseBy(java.lang.String baseBy)

Get search mode

Parameters:

baseBy - search mode base

SetNoOutputFlag

public void SetNoOutputFlag(boolean noOutputFlag)

Set no output flag

Parameters:

noOutputFlag - blloean flag for noOutput

GetNoOutputFlag

public boolean GetNoOutputFlag()

SetShowTotalRecNum

public void SetShowTotalRecNum(boolean showTotalRecNum)

GetShowTotalRecNum

public boolean GetShowTotalRecNum()

SetShowQuery

public void SetShowQuery(boolean showQuery)

GetShowQuery

public boolean GetShowQuery()

SetSeparator

public void SetSeparator(java.lang.String separator)

GetSeparator

public java.lang.String GetSeparator()

SetLexRecordFormat

public void SetLexRecordFormat(int format)

GetLexRecordFormat

public int GetLexRecordFormat()

GetOutFilterCategory

public long GetOutFilterCategory()

SetOutCategoryFilter

public void SetOutCategoryFilter(java.util.Vector<java.lang.Boolean> outCategoryValues)

ResetAllOptions

public void ResetAllOptions()

SetInSource

public void SetInSource(int inSource)

GetInSource

public int GetInSource()

GetDefaultInFile

public java.lang.String GetDefaultInFile()

SetOutSource

public void SetOutSource(int outSource)

GetOutSource

public int GetOutSource()

GetDefaultOutFile

public java.lang.String GetDefaultOutFile()

SetInFile

public void SetInFile(java.io.File inFile)

GetInFile

public java.io.File GetInFile()

SetOutFile

public void SetOutFile(java.io.File outFile)

GetOutFile

public java.io.File GetOutFile()

SetAppendToOutFile

public void SetAppendToOutFile(boolean appendToOutFile)

GetAppendToOutFile

public boolean GetAppendToOutFile()

SetDataType

public void SetDataType(int dataType)

GetDataType

public int GetDataType()

SetDataVersion

public void SetDataVersion(java.lang.String dataVersion)

GetDataVersion

public java.lang.String GetDataVersion()

GetDbVersion

public java.lang.String GetDbVersion()

ResetDbConnection

public boolean ResetDbConnection()