ubc.cs.JLog.Applet
Class gJLogBase

java.lang.Object
  extended by ubc.cs.JLog.Applet.gJLogBase
All Implemented Interfaces:
iJLogApplBaseServices, iPrologFileServices

public class gJLogBase
extends java.lang.Object
implements iJLogApplBaseServices

This is the base class for applets or applications using the Prolog in Java environment. It includes jPrologServices, but does not specify the user interface. It is designed to be a delegate class for the gJLogAppletBase or gJLogApplicationBase classes which need the jPrologServices. Derivative authors should ensure that the credits from getRequiredCreditInfo function are preserved and visible in their own product.

Author:
Glendon Holst

Field Summary
protected  iJLogApplBaseServices parent
           
protected  jPrologServices prolog
           
 
Constructor Summary
gJLogBase(iJLogApplBaseServices p)
          Constructor.
 
Method Summary
 java.lang.String convertStringLinebreaks(java.lang.String param)
           
 void destroy()
           
 java.awt.Image getImage(java.lang.String name)
           
 java.io.InputStream getInputStreamFromFilename(java.lang.String name)
           
 java.lang.String getParameter(java.lang.String name)
           
 java.lang.String[][] getParameterInfo()
           
 jPrologServices getPrologServices()
           
 java.lang.String getRequiredCreditInfo()
          This function returns the credit assignment and copyright informaiton string.
 java.io.InputStream getResourceInputStreamFromFilename(java.lang.String name)
           
 java.net.URL getResourceURLFromFilename(java.lang.String name)
           
 java.lang.String getSource()
           
 java.lang.String getTextFromInputStream(java.io.InputStream in_strm)
           
 java.net.URL getURLFromFilename(java.lang.String name)
           
 void init()
           
 void start()
           
 void stop()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

prolog

protected jPrologServices prolog

parent

protected iJLogApplBaseServices parent
Constructor Detail

gJLogBase

public gJLogBase(iJLogApplBaseServices p)
Constructor. Requires a parent delegate of type iJLogApplBaseServices The delegate is invoked first, and can override the behaviours of the member functions.

Parameters:
p - The parent delegate instance for this object.
Method Detail

init

public void init()

start

public void start()

stop

public void stop()

destroy

public void destroy()

getRequiredCreditInfo

public java.lang.String getRequiredCreditInfo()
This function returns the credit assignment and copyright informaiton string. It must be preserved by authors of derivative works. All applets should be derived from the gJLogAppletBase class, and if they provide their own getAppletInfo() function it should invoke this function first. For example: return super.getAppletInfo() + "derivative information";

Specified by:
getRequiredCreditInfo in interface iJLogApplBaseServices
Returns:
The credit and information string.

getParameterInfo

public java.lang.String[][] getParameterInfo()

getSource

public java.lang.String getSource()
                           throws java.io.IOException
Specified by:
getSource in interface iJLogApplBaseServices
Throws:
java.io.IOException

getURLFromFilename

public java.net.URL getURLFromFilename(java.lang.String name)
                                throws java.net.MalformedURLException,
                                       java.io.IOException
Specified by:
getURLFromFilename in interface iJLogApplBaseServices
Specified by:
getURLFromFilename in interface iPrologFileServices
Throws:
java.net.MalformedURLException
java.io.IOException

getInputStreamFromFilename

public java.io.InputStream getInputStreamFromFilename(java.lang.String name)
                                               throws java.net.MalformedURLException,
                                                      java.io.IOException
Specified by:
getInputStreamFromFilename in interface iJLogApplBaseServices
Specified by:
getInputStreamFromFilename in interface iPrologFileServices
Throws:
java.net.MalformedURLException
java.io.IOException

getResourceURLFromFilename

public java.net.URL getResourceURLFromFilename(java.lang.String name)
                                        throws java.net.MalformedURLException,
                                               java.io.IOException
Specified by:
getResourceURLFromFilename in interface iPrologFileServices
Throws:
java.net.MalformedURLException
java.io.IOException

getResourceInputStreamFromFilename

public java.io.InputStream getResourceInputStreamFromFilename(java.lang.String name)
                                                       throws java.net.MalformedURLException,
                                                              java.io.IOException
Specified by:
getResourceInputStreamFromFilename in interface iPrologFileServices
Throws:
java.net.MalformedURLException
java.io.IOException

getTextFromInputStream

public java.lang.String getTextFromInputStream(java.io.InputStream in_strm)
                                        throws java.io.IOException
Specified by:
getTextFromInputStream in interface iJLogApplBaseServices
Specified by:
getTextFromInputStream in interface iPrologFileServices
Throws:
java.io.IOException

getParameter

public java.lang.String getParameter(java.lang.String name)
Specified by:
getParameter in interface iJLogApplBaseServices

convertStringLinebreaks

public java.lang.String convertStringLinebreaks(java.lang.String param)
Specified by:
convertStringLinebreaks in interface iJLogApplBaseServices

getImage

public java.awt.Image getImage(java.lang.String name)
Specified by:
getImage in interface iJLogApplBaseServices

getPrologServices

public jPrologServices getPrologServices()
Specified by:
getPrologServices in interface iJLogApplBaseServices