Rule Execution Server API

ilog.rules.archive
Class IlrRulesetArchiveLoader

java.lang.Object
  extended by ilog.rules.archive.IlrRulesetArchiveLoader
Direct Known Subclasses:
IlrArchiveLoader, IlrJarArchiveLoader

public abstract class IlrRulesetArchiveLoader
extends Object

An abstract class to load the contents of a ruleset archive.

Since:
JRules 6.0
See Also:
IlrJarArchiveLoader, IlrArchiveLoader

Method Summary
 void endLoad()
          Called when the archive load is terminated.
 IlrRulesetArchive.Element getCompressedEntry(String entryName)
          Returns the compressed content of the archive element.
 IlrRulesetArchive getCurrentArchive()
          Returns the current archive used by the loader.
abstract  IlrRulesetArchive.Element getEntry(String entryName)
          Returns the content of an archive element.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getEntry

public abstract IlrRulesetArchive.Element getEntry(String entryName)
Returns the content of an archive element.

Parameters:
entryName - The name of the entry.
Returns:
An IlrRulesetArchive.Element that represents the contents of the entry.

getCompressedEntry

public IlrRulesetArchive.Element getCompressedEntry(String entryName)
Returns the compressed content of the archive element. By default the method returns null. It is up to the developer who implements this interface to provide, if needed, an implementation of this method.

When the archive is loaded, the getCompressedEntry is first called. If it returns null, the getEntry method is called.

Parameters:
entryName - The name of the entry.
Returns:
An IlrRulesetArchive.Element that represents the compressed contents of the entry.

endLoad

public void endLoad()
Called when the archive load is terminated. This method makes possible an operation after the archive loading: closing a stream or a connection, for example.


getCurrentArchive

public IlrRulesetArchive getCurrentArchive()
Returns the current archive used by the loader.

Returns:
The current archive used by the loader.

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013