Package net.sf.saxon.event
Class HTMLURIEscaper
- java.lang.Object
-
- net.sf.saxon.event.SequenceReceiver
-
- net.sf.saxon.event.ProxyReceiver
-
- net.sf.saxon.event.HTMLURIEscaper
-
- All Implemented Interfaces:
javax.xml.transform.Result
,Receiver
- Direct Known Subclasses:
XHTMLURIEscaper
public class HTMLURIEscaper extends ProxyReceiver
This class is used as a filter on the serialization pipeline; it performs the function of escaping URI-valued attributes in HTML- Author:
- Michael H. Kay
-
-
Field Summary
Fields Modifier and Type Field Description protected int
currentElement
protected boolean
escapeURIAttributes
protected NamePool
pool
-
Fields inherited from class net.sf.saxon.event.ProxyReceiver
nextReceiver
-
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
-
-
Constructor Summary
Constructors Constructor Description HTMLURIEscaper()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties)
Notify an attribute.static java.lang.CharSequence
escapeURL(java.lang.CharSequence url, boolean normalize)
Escape a URI according to the HTML rules: that is, a non-ASCII character (specifically, a character outside the range 32 - 126) is replaced by the %HH encoding of the octets in its UTF-8 representationboolean
isUrlAttribute(int element, int attribute)
void
startDocument(int properties)
Start of a document node.void
startElement(int nameCode, int typeCode, int locationId, int properties)
Notify the start of an element-
Methods inherited from class net.sf.saxon.event.ProxyReceiver
append, characters, close, comment, endDocument, endElement, getConfiguration, getDocumentLocator, getNamePool, getUnderlyingReceiver, namespace, open, processingInstruction, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent
-
Methods inherited from class net.sf.saxon.event.SequenceReceiver
getPipelineConfiguration, getSystemId
-
-
-
-
Field Detail
-
currentElement
protected int currentElement
-
escapeURIAttributes
protected boolean escapeURIAttributes
-
pool
protected NamePool pool
-
-
Method Detail
-
isUrlAttribute
public boolean isUrlAttribute(int element, int attribute)
-
startDocument
public void startDocument(int properties) throws XPathException
Start of a document node.- Specified by:
startDocument
in interfaceReceiver
- Overrides:
startDocument
in classProxyReceiver
- Parameters:
properties
- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOptions
- Throws:
XPathException
-
startElement
public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException
Notify the start of an element- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in classProxyReceiver
- Parameters:
nameCode
- integer code identifying the name of the element within the name pool.typeCode
- integer code identifying the element's type within the name pool.properties
- properties of the element nodelocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.- Throws:
XPathException
-
attribute
public void attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties) throws XPathException
Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.- Specified by:
attribute
in interfaceReceiver
- Overrides:
attribute
in classProxyReceiver
- Parameters:
nameCode
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name poolproperties
- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this attribute
- NO_SPECIAL_CHARACTERS
- Attribute value contains no special characters
value
- the string value of the attributelocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.- Throws:
XPathException
-
escapeURL
public static java.lang.CharSequence escapeURL(java.lang.CharSequence url, boolean normalize)
Escape a URI according to the HTML rules: that is, a non-ASCII character (specifically, a character outside the range 32 - 126) is replaced by the %HH encoding of the octets in its UTF-8 representation- Parameters:
url
- the URI to be escapednormalize
-- Returns:
- the URI after escaping non-ASCII characters
-
-