|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines an API for reading Concepts from some input source. This source can be MR Files, update MR Files, a database, or pretty much anything else.
Method Summary | |
void |
close()
Closes the input stream. |
int |
getConceptProgress()
Return an int between 0 and 100 indicating
how far along the input stream is in reading Concept s. |
String |
getConfigurationDetails()
Returns a String describing the configuration details. |
int |
getIndexProgress()
Return an int between 0 and 100 indicating
how far along the input stream is in reading IndexEntry
elements. |
String |
getName()
Returns a descriptive, yet short, name of the input stream for display purposes. |
void |
open(String input_loc)
Opens the input stream. |
Concept |
readConcept()
Read a Concept from the input stream and return it. |
IndexEntry |
readIndexEntry()
Read an IndexEntry from the input stream and return it. |
ReleaseMetadata |
readReleaseMetadata()
Read the ReleaseMetadata from the input stream and return it. |
void |
setConfiguration(UserConfiguration config)
Sets the UserConfiguration . |
void |
setCuiList(CuiList cui_list)
Provides input stream access to the cui list. |
Method Detail |
public String getName()
public void setConfiguration(UserConfiguration config)
UserConfiguration
. In certain cases,
input streams may require information provided by the application
configuration.
config
- the UserConfiguration
public void open(String input_loc) throws Exception
input_loc
- locator information for the input stream
Exception
- if there is a problem opening filespublic void close() throws Exception
Exception
- if there is a problem closing filespublic Concept readConcept() throws Exception
Concept
from the input stream and return it.
This method should provide the mapping between the input
files and Concept
objects. Furthermore, it should
be implemented like a stream, in the sense that only the
content for the next Concept
should be read into memory.
Concept
read from the input stream
Exception
- if there is a problem reading the conceptpublic IndexEntry readIndexEntry() throws Exception
IndexEntry
from the input stream and return it.
This method should provide the mapping between the input
files and IndexEntry
objects. Futhermore, it should be
implemented like a stream, in the sense that only the content
for the next IndexEntry
should be read into memory.
IndexEntry
Exception
- if there is a problem reading the index entrypublic ReleaseMetadata readReleaseMetadata() throws Exception
ReleaseMetadata
from the input stream and return it.
ReleaseMetadata
Exception
- if there is a problem
reading the release metadatapublic int getConceptProgress()
int
between 0 and 100 indicating
how far along the input stream is in reading Concept
s.
This information can be used for a progress monitor.
int
representing percentage completepublic int getIndexProgress()
int
between 0 and 100 indicating
how far along the input stream is in reading IndexEntry
elements. This information can be used for a progress monitor.
int
representing percentage completepublic String getConfigurationDetails()
String
describing the configuration details.
This is a mechanism for the input stream to write details of
its operation to the log file that MetamorphoSys
eventually produces.
String
describing the configuration detailspublic void setCuiList(CuiList cui_list)
cui_list
- CuiList
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |