com.sapportals.wcm.util.html
Class HTMLFilterImpl

[contained in: com.sap.netweaver.bc.util.par - bc.util.public_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.util.html.HTMLFilterImpl

All Implemented Interfaces:

IHTMLContentHandler, IHTMLFilter, IHTMLReader

Direct Known Subclasses:

HTMLScriptRemover

public class HTMLFilterImpl

extends java.lang.Object

implements IHTMLFilter, IHTMLContentHandler

Default Implementation of IHTMLFilter.

Provides a default implmentation which is the null filter. It forwards all events unchanged to its content handler.

Filters only interested in a subset of the events can extend this class to ease their implementation effort.

Copyright (c) SAP AG 2001-2002

Constructor Summary

HTMLFilterImpl()
Empty filter with a parent reader installed.

HTMLFilterImpl(IHTMLReader reader)
Filter which receives its events from the given reader.

Method Summary

void	characters(char[] ch, int start, int length) Notification of a character event.
void	discard() Free all allocated resources.
void	endDocument() Notification that the document is finished.
void	endElement(IHTMLElement element) Notification that an end tag was encountered (e.g. starting with '</').
IHTMLContentHandler	getContentHandler() Get the registered content handler.
java.lang.String	getEncoding() Return the encoding used in the document.
IHTMLReader	getParent() Get the reader this filter gets its events from.
void	parse() Parse the complete document, generating events, until the source is read emtpy.
boolean	parseNextEvent() Parse the document, generating an events, and return to the caller.
void	setContentHandler(IHTMLContentHandler handler) Set the content handler to a new value.
void	setParent(IHTMLReader reader) Set the reader where this filter should get its events from.
void	setSource(java.io.InputStream input) Set InputStream as document source.
void	setSource(java.io.InputStream input, java.lang.String encoding) Set InputStream as document source, use the given encoding.
void	setSource(java.io.Reader input) Set Reader as document source, encoding is irrelevant.
void	startDocument() Notification that the document is about to start.
void	startElement(IHTMLElementStart element) Notification that a tag was encountered.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLFilterImpl

public HTMLFilterImpl()

Empty filter with a parent reader installed.

HTMLFilterImpl

public HTMLFilterImpl(IHTMLReader reader)

Filter which receives its events from the given reader.

Parameters:

reader - to get events from

Method Detail

getParent

public IHTMLReader getParent()

Description copied from interface: IHTMLFilter

Get the reader this filter gets its events from.

Specified by:

getParent in interface IHTMLFilter

Following copied from interface: com.sapportals.wcm.util.html.IHTMLFilter

Returns:

parent reader

setParent

public void setParent(IHTMLReader reader)

Description copied from interface: IHTMLFilter

Set the reader where this filter should get its events from.

Specified by:

setParent in interface IHTMLFilter

Following copied from interface: com.sapportals.wcm.util.html.IHTMLFilter

Parameters:

reader - new parent reader

getContentHandler

public IHTMLContentHandler getContentHandler()

Description copied from interface: IHTMLReader

Get the registered content handler. Returns null if none is installed.

Specified by:

getContentHandler in interface IHTMLReader

Following copied from interface: com.sapportals.wcm.util.html.IHTMLReader

Returns:

registered content handler

setSource

public void setSource(java.io.InputStream input)
               throws HTMLException,
                      java.io.IOException

Description copied from interface: IHTMLReader

Set InputStream as document source. Encoding will be detected.

Specified by:

setSource in interface IHTMLReader

Following copied from interface: com.sapportals.wcm.util.html.IHTMLReader

Parameters:

input - stream to read document from

Throws:

HTMLException - when document is not legal HTML

java.io.IOException - on read errors

setSource

public void setSource(java.io.InputStream input,
                      java.lang.String encoding)
               throws HTMLException,
                      java.io.IOException

Description copied from interface: IHTMLReader

Set InputStream as document source, use the given encoding.

Specified by:

setSource in interface IHTMLReader

Following copied from interface: com.sapportals.wcm.util.html.IHTMLReader

Parameters:

input - stream to read document from

encoding - to use for stream

Throws:

HTMLException - when document is not legal HTML

java.io.IOException - on read errors

setSource

public void setSource(java.io.Reader input)
               throws HTMLException,
                      java.io.IOException

Description copied from interface: IHTMLReader

Set Reader as document source, encoding is irrelevant.

Specified by:

setSource in interface IHTMLReader

Following copied from interface: com.sapportals.wcm.util.html.IHTMLReader

Parameters:

input - to read document from

Throws:

HTMLException - when document is not legal HTML

java.io.IOException - on read errors

setContentHandler

public void setContentHandler(IHTMLContentHandler handler)

Description copied from interface: IHTMLReader

Set the content handler to a new value. null is allowed to deregister an installed handler.

Specified by:

setContentHandler in interface IHTMLReader

Following copied from interface: com.sapportals.wcm.util.html.IHTMLReader

Parameters:

handler - to register

getEncoding

public java.lang.String getEncoding()
                             throws HTMLException,
                                    java.io.IOException

Description copied from interface: IHTMLReader

Return the encoding used in the document.

Specified by:

getEncoding in interface IHTMLReader

Following copied from interface: com.sapportals.wcm.util.html.IHTMLReader

Returns:

encoding used in document or null if unknown.

Throws:

HTMLException - when document is not legal HTML

java.io.IOException - on read errors

parse

public void parse()
           throws HTMLException,
                  java.io.IOException

Description copied from interface: IHTMLReader

Parse the complete document, generating events, until the source is read emtpy.

Specified by:

parse in interface IHTMLReader

Following copied from interface: com.sapportals.wcm.util.html.IHTMLReader

Throws:

HTMLException - when document is not legal HTML

java.io.IOException - on read errors

parseNextEvent

public boolean parseNextEvent()
                       throws HTMLException,
                              java.io.IOException

Description copied from interface: IHTMLReader

Parse the document, generating an events, and return to the caller. Will return true as long as there are more events to read.

Specified by:

parseNextEvent in interface IHTMLReader

Following copied from interface: com.sapportals.wcm.util.html.IHTMLReader

Returns:

if there are more events to read

Throws:

HTMLException - when document is not legal HTML

java.io.IOException - on read errors

discard

public void discard()

Description copied from interface: IHTMLReader

Free all allocated resources. Not necessary to call when parsing has finished.

Specified by:

discard in interface IHTMLReader

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws HTMLException

Description copied from interface: IHTMLContentHandler

Notification of a character event. The characters of the event are found in ch at offset start . There are length number of characters.

The content of the buffer before start or after start + length is undefined. Modification of the character array is strictly forbidden. The content of the array is undefined after this method returns.

Specified by:

characters in interface IHTMLContentHandler

Following copied from interface: com.sapportals.wcm.util.html.IHTMLContentHandler

Parameters:

ch - array holding characters of event

start - where in the array the characters begin

length - number of characters in event

Throws:

HTMLException - to indicate error in event handling

endDocument

public void endDocument()
                 throws HTMLException

Description copied from interface: IHTMLContentHandler

Notification that the document is finished.

Specified by:

endDocument in interface IHTMLContentHandler

Following copied from interface: com.sapportals.wcm.util.html.IHTMLContentHandler

Throws:

HTMLException - to indicate error in event handling

endElement

public void endElement(IHTMLElement element)
                throws HTMLException

Description copied from interface: IHTMLContentHandler

Notification that an end tag was encountered (e.g. starting with '</'). The element paramter is only valid for the duration of the call. The content of element are undefined when the method returns. See IHTMLElement for further information.

Specified by:

endElement in interface IHTMLContentHandler

Following copied from interface: com.sapportals.wcm.util.html.IHTMLContentHandler

Parameters:

element - TBD: Description of the incoming method parameter

Throws:

HTMLException - to indicate error in event handling

startDocument

public void startDocument()
                   throws HTMLException

Description copied from interface: IHTMLContentHandler

Notification that the document is about to start.

Specified by:

startDocument in interface IHTMLContentHandler

Following copied from interface: com.sapportals.wcm.util.html.IHTMLContentHandler

Throws:

HTMLException - to indicate error in event handling

startElement

public void startElement(IHTMLElementStart element)
                  throws HTMLException

Description copied from interface: IHTMLContentHandler

Notification that a tag was encountered. The element paramter is only valid for the duration of the call. The content of element are undefined when the method returns. See IHTMLElementStart for further information.

Specified by:

startElement in interface IHTMLContentHandler

Following copied from interface: com.sapportals.wcm.util.html.IHTMLContentHandler

Parameters:

element - TBD: Description of the incoming method parameter

Throws:

HTMLException - to indicate error in event handling