com.bbn.swede.core.libraries
Interface ILibraryEntryDescriptor

All Known Implementing Classes:
LibraryEntryDescriptor

public interface ILibraryEntryDescriptor

Classes which implement this interface represent the main way used to interface with ILibraryEntry objects.

Author:
aperezlo

Method Summary
 boolean close()
          Attempts to release all system resources associated with the ILibraryEntry.
 IConfiguration getConfiguration()
          Retrieves the IConfiguration of this library entry.
 ILibraryEntry getEntry()
          Retrieves the ILibraryEntry associated with this descriptor.
 InputStream getFileInputStream()
          Returns an InputStream to the file associated with this Entry.
 IOWLAbstractSyntaxTree getOAST()
          Retrieves the OWL abstract syntax tree associated with this entry.
 boolean hasOAST()
          Indicates whether the library entry represented by this object has an OWL abstract syntax tree associated with it.
 

Method Detail

close

public boolean close()
Attempts to release all system resources associated with the ILibraryEntry.

Returns:
true if the operation was successful, false otherwise

getConfiguration

public IConfiguration getConfiguration()
Retrieves the IConfiguration of this library entry.

Returns:
the configuration object associated with this entry descriptor

getEntry

public ILibraryEntry getEntry()
Retrieves the ILibraryEntry associated with this descriptor.

Returns:
the library entry

hasOAST

public boolean hasOAST()
Indicates whether the library entry represented by this object has an OWL abstract syntax tree associated with it.

Returns:
true if this object's ILibraryEntry has an OAST associated with it, false otherwise

getFileInputStream

public InputStream getFileInputStream()
Returns an InputStream to the file associated with this Entry.

Note: it can not be assumed that the input stream returned will be a FileInputStream, in spite of the name of this method

Returns:
a InputStream to the file associated with this Entry

getOAST

public IOWLAbstractSyntaxTree getOAST()
Retrieves the OWL abstract syntax tree associated with this entry.

Returns:
the IOWLAbstractSyntaxTree associated with this Entry, or null if one does not exist


Copyright © 2004-2005 BBN Technologies. All Rights Reserved.