gov.nih.nlm.nls.lexCheck.Api

Class ApiOutput

java.lang.Object

gov.nih.nlm.nls.lexCheck.Api.ApiOutput

public class ApiOutput
extends java.lang.Object

This class provides an Java object for LexCheck API output.

History:

Version:

V-2019

Author:

NLM Lexical System Development Team

Constructor Summary

Constructors

Constructor and Description
ApiOutput(java.lang.String xml, int recordNum) Creates a java object for LexCheck Api output and initiate related data

Method Summary

Modifier and Type	Method and Description
int	GetRecordNum() A method to get the total number of Lexical records
java.lang.String	GetXml() A method to get the Xml output of Lexical records
void	SetRecordNum(int recordNum) A method to set the total number of Lexical records
void	SetXml(java.lang.String xml) A method to set the Xml output

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiOutput

public ApiOutput(java.lang.String xml,
                 int recordNum)

Creates a java object for LexCheck Api output and initiate related data

Parameters:

xml - xml representation of lexical records

recordNum - number of lexical records

Method Detail

SetXml

public void SetXml(java.lang.String xml)

A method to set the Xml output

Parameters:

xml - the Xml output for the lexical records

SetRecordNum

public void SetRecordNum(int recordNum)

A method to set the total number of Lexical records

Parameters:

recordNum - the total number of Lexical records

GetXml

public java.lang.String GetXml()

A method to get the Xml output of Lexical records

Returns:

the Xml output for the lexical records in String format

GetRecordNum

public int GetRecordNum()

A method to get the total number of Lexical records

Returns:

the total number of of lexical records