oracle.help.engine
Class DataEngine

java.lang.Object
  |
  +--oracle.help.engine.DataEngine

public abstract class DataEngine

extends java.lang.Object

Each View in a book will have a DataEngine for getting its data. For example, you may have a View of a oracle.help.navigator.tocNavigator.TOCNavigator that uses a DataEngine oracle.help.engine.XMLTOCEngine. Instances of DataEngine should only implement the abstract method

public abstract Object createDataObject(View view, String basePath, URL url, String encoding) throws IOException

One can create custom DataEngines to create any sort of custom Object after doing work processing a file.

Field Summary

protected java.lang.String

engineParams

Constructor Summary

DataEngine()

Method Summary

protected java.io.BufferedReader	_getBufferedReader(java.net.URL aURL, java.lang.String encoding) Get a BufferredReader for the file at URL aURL that uses the specified encoding.
java.lang.Object	createDataObject(oracle.help.common.View view, java.lang.String basePath, java.lang.String filename, java.lang.String encoding) Create an Object for the file at the specified file system basePath and filename that uses the specified encoding
abstract java.lang.Object	createDataObject(oracle.help.common.View view, java.lang.String basePath, java.net.URL url, java.lang.String encoding) Create an object for a file at the specified URL that uses the specified encoding
java.lang.Object	createDataObject(oracle.help.common.View view, java.lang.String basePath, java.net.URL url, java.lang.String encoding, java.lang.String engineParams) Create an Object for a file at URL url that uses the specified encoding and engine parameters engineParams.

Methods inherited from class java.lang.Object

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

Field Detail

engineParams

protected java.lang.String engineParams

Constructor Detail

DataEngine

public DataEngine()

Method Detail

createDataObject

public java.lang.Object createDataObject(oracle.help.common.View view,
                                         java.lang.String basePath,
                                         java.net.URL url,
                                         java.lang.String encoding,
                                         java.lang.String engineParams)
                                  throws java.io.IOException

Create an Object for a file at URL url that uses the specified encoding and engine parameters engineParams.

createDataObject

public java.lang.Object createDataObject(oracle.help.common.View view,
                                         java.lang.String basePath,
                                         java.lang.String filename,
                                         java.lang.String encoding)
                                  throws java.io.IOException,
                                         java.net.MalformedURLException

Create an Object for the file at the specified file system basePath and filename that uses the specified encoding

createDataObject

public abstract java.lang.Object createDataObject(oracle.help.common.View view,
                                                  java.lang.String basePath,
                                                  java.net.URL url,
                                                  java.lang.String encoding)
                                           throws java.io.IOException

Create an object for a file at the specified URL that uses the specified encoding

_getBufferedReader

protected java.io.BufferedReader _getBufferedReader(java.net.URL aURL,
                                                    java.lang.String encoding)
                                             throws java.io.IOException

Get a BufferredReader for the file at URL aURL that uses the specified encoding.