org.ametys.core.cocoon

Class XHTMLSerializer

java.lang.Object

org.apache.cocoon.components.serializers.EncodingSerializer

org.apache.cocoon.components.serializers.XMLSerializer

org.apache.cocoon.components.serializers.XHTMLSerializer

org.ametys.core.cocoon.XHTMLSerializer

All Implemented Interfaces:

Poolable, Recyclable, Component, Configurable, LogEnabled, Serviceable, Serializer, SitemapOutputComponent, XMLConsumer, ContentHandler, LexicalHandler, Locator

public class XHTMLSerializer
extends XHTMLSerializer
implements LogEnabled, Serviceable

Inherits from cocoon's serializers block XHTMLSerializer.

The following configuration can be used:

 <omit-xml-declaration>yes|no</omit-xml-declaration>
 <tags-to-collapse>input,meta</tags-to-collapse>
 <namespace-allowed></namespace-allowed>
 <namespace-allowed>http://www.w3.org/XML/1998/namespace</namespace-allowed>
 <namespace-allowed>http://www.w3.org/1999/xhtml</namespace-allowed>
 

Empty tags are not collapsed except the ones configured with tags-to-collapse.
If there is no such configuration, default tags to collaspe are:

• input
• img
• meta
• link
• hr
• br

Namespace tags and attributes are filtered to product valid XHTML. This is configureable using namespace-allowed, by default the only following namespaces are allowed:

• "" (empty namespace)
• "http://www.w3.org/XML/1998/namespace"
• "http://www.w3.org/1999/xhtml"
• "http://www.w3.org/2000/svg"
• "http://www.w3.org/1998/Math/MathML"

Content of script tags will be exported in a single comment.

omit-xml-declaration is set to yes by default for compatibility purpose (IE 6). If omit-xml-declaration is set to no, Content-Type meta tag will be dropped if present.

Since:

1.1.5 this serializer is JAXP compliant with the processing instruction javax.xml.transform.*-output-escaping processing.

See Also:

Result

Field Summary

Fields

Modifier and Type	Field and Description
private static Set<String>	__COLLAPSE_TAGS List of the tags to collapse.
private static String	__HEAD_TAG Head tag.
private static String	__META_CONTENT_ATTR Meta content attribute name.
private static String	__META_HTTP_EQUIV_ATTR Meta HTTP equiv attribute name.
private static String	__META_HTTP_EQUIV_CTYPE_VALUE Meta HTTP equiv attribute value for content type.
private static String	__META_TAG Meta tag.
private static Set<String>	__NAMESPACES_ALLOWED List of the tags to collapse.
private static String	__SCRIPT_TAG Script tag.
private static String	__STYLE_TAG Style tag.
private StringBuilder	_buffer Buffer to store script tag content.
private boolean	_disableOutputEscaping Flag for disabling output escaping states encountered with javax.xml.transform.*-output-escaping processing instructions.
private int	_insideFilteredTag Inside filtered tag: greater than 0 if we are inside a filtered tag.
private int	_insideInlineResourceTag Inline resource context: greater than 0 if we are inside a style or a script tag.
private boolean	_isMetaContentType Meta http-equiv="Content-Type" context.
private Logger	_logger
private Set<String>	_namespacesAllowed Namespaces allowed.
private Set<String>	_namespacesPrefixFiltered Namespaces prefixe filtered.
private boolean	_omitXmlDeclaration Define whether to put XML declaration in the head of the document.
private int	_tagsInsideInlineResourceTag
private Set<String>	_tagsToCollapse Buffer to store tag to collapse.
protected XHTMLSerializerExtensionPoint	_xhtmlSerializerExtensionPoint The XHTMLSerializerExtensionPoint instance

Fields inherited from class org.apache.cocoon.components.serializers.XHTMLSerializer

doctype_default, encodeCharacters, XHTML1_DOCTYPE_FRAMESET, XHTML1_DOCTYPE_STRICT, XHTML1_DOCTYPE_TRANSITIONAL, XHTML1_NAMESPACE, XHTML5_DOCTYPE

Fields inherited from class org.apache.cocoon.components.serializers.XMLSerializer

doctype

Fields inherited from class org.apache.cocoon.components.serializers.EncodingSerializer

ATTRIBUTE_LENGTH, ATTRIBUTE_LOCAL, ATTRIBUTE_NSURI, ATTRIBUTE_QNAME, ATTRIBUTE_VALUE, charset, indentPerLevel, namespaces

Fields inherited from interface org.apache.cocoon.serialization.Serializer

ROLE

Constructor Summary

Constructors

Constructor and Description
XHTMLSerializer()

Method Summary

Modifier and Type	Method and Description
private Attributes	_filterAttributes(Attributes attributes)
void	characters(char[] ch, int start, int length)
void	charactersImpl(char[] data, int start, int length)
void	comment(char[] data, int start, int length)
void	configure(Configuration conf)
void	enableLogging(Logger logger)
void	endElement(String nsuri, String local, String qual)
void	endElementImpl(String uri, String local, String qual)
void	endPrefixMapping(String prefix)
void	ignorableWhitespace(char[] data, int start, int length)
private boolean	isJsScript(String local, String[][] attributes)
private boolean	isMetaContentType(String local, String[][] attributes)
void	processingInstruction(String target, String data)
void	recycle()
void	service(ServiceManager manager)
void	startElement(String nsuri, String local, String qual, Attributes attributes)
void	startElementImpl(String uri, String local, String qual, String[][] lNamespaces, String[][] attributes)
void	startPrefixMapping(String prefix, String uri)

Methods inherited from class org.apache.cocoon.components.serializers.XHTMLSerializer

body, encode, getMimeType, head, isCdataElement

Methods inherited from class org.apache.cocoon.components.serializers.XMLSerializer

closeElement, endCDATA, endDocument, endDTD, endEntity, skippedEntity, startCDATA, startDocument, startDTD, startEntity

Methods inherited from class org.apache.cocoon.components.serializers.EncodingSerializer

encode, encode, flush, getColumnNumber, getLineNumber, getLocation, getPublicId, getSystemId, setDocumentLocator, setOutputStream, shouldSetContentLength, write, write, write, write, write, writeIndent, writeln, writeln

Methods inherited from class java.lang.Object

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

Field Detail

__NAMESPACES_ALLOWED

private static final Set<String> __NAMESPACES_ALLOWED

List of the tags to collapse.

__COLLAPSE_TAGS

private static final Set<String> __COLLAPSE_TAGS

List of the tags to collapse.

__HEAD_TAG

private static final String __HEAD_TAG

Head tag.

See Also:

Constant Field Values

__META_TAG

private static final String __META_TAG

Meta tag.

See Also:

Constant Field Values

__META_HTTP_EQUIV_ATTR

private static final String __META_HTTP_EQUIV_ATTR

Meta HTTP equiv attribute name.

See Also:

Constant Field Values

__META_HTTP_EQUIV_CTYPE_VALUE

private static final String __META_HTTP_EQUIV_CTYPE_VALUE

Meta HTTP equiv attribute value for content type.

See Also:

Constant Field Values

__META_CONTENT_ATTR

private static final String __META_CONTENT_ATTR

Meta content attribute name.

See Also:

Constant Field Values

__SCRIPT_TAG

private static final String __SCRIPT_TAG

Script tag.

See Also:

Constant Field Values

__STYLE_TAG

private static final String __STYLE_TAG

Style tag.

See Also:

Constant Field Values

_xhtmlSerializerExtensionPoint

protected XHTMLSerializerExtensionPoint _xhtmlSerializerExtensionPoint

The XHTMLSerializerExtensionPoint instance

_buffer

private StringBuilder _buffer

Buffer to store script tag content.

_tagsToCollapse

private Set<String> _tagsToCollapse

Buffer to store tag to collapse.

_namespacesAllowed

private Set<String> _namespacesAllowed

Namespaces allowed.

_namespacesPrefixFiltered

private Set<String> _namespacesPrefixFiltered

Namespaces prefixe filtered.

_insideFilteredTag

private int _insideFilteredTag

Inside filtered tag: greater than 0 if we are inside a filtered tag.

_insideInlineResourceTag

private int _insideInlineResourceTag

Inline resource context: greater than 0 if we are inside a style or a script tag.

_tagsInsideInlineResourceTag

private int _tagsInsideInlineResourceTag

_disableOutputEscaping

private boolean _disableOutputEscaping

Flag for disabling output escaping states encountered with javax.xml.transform.*-output-escaping processing instructions.

_omitXmlDeclaration

private boolean _omitXmlDeclaration

Define whether to put XML declaration in the head of the document.

_isMetaContentType

private boolean _isMetaContentType

Meta http-equiv="Content-Type" context. True if we are inside a meta "content-type" tag.

_logger

private Logger _logger

Constructor Detail

XHTMLSerializer

public XHTMLSerializer()

Method Detail

enableLogging

public void enableLogging(Logger logger)

Specified by:

enableLogging in interface LogEnabled

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration conf)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class XHTMLSerializer

Throws:

ConfigurationException

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class EncodingSerializer

Throws:

SAXException

startElement

public void startElement(String nsuri,
                         String local,
                         String qual,
                         Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class EncodingSerializer

Throws:

SAXException

_filterAttributes

private Attributes _filterAttributes(Attributes attributes)

startElementImpl

public void startElementImpl(String uri,
                             String local,
                             String qual,
                             String[][] lNamespaces,
                             String[][] attributes)
                      throws SAXException

Overrides:

startElementImpl in class XHTMLSerializer

Throws:

SAXException

characters

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

Specified by:

characters in interface ContentHandler

Overrides:

characters in class EncodingSerializer

Throws:

SAXException

charactersImpl

public void charactersImpl(char[] data,
                           int start,
                           int length)
                    throws SAXException

Overrides:

charactersImpl in class XMLSerializer

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] data,
                                int start,
                                int length)
                         throws SAXException

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class XMLSerializer

Throws:

SAXException

comment

public void comment(char[] data,
                    int start,
                    int length)
             throws SAXException

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class XMLSerializer

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class XMLSerializer

Throws:

SAXException

endElement

public void endElement(String nsuri,
                       String local,
                       String qual)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class EncodingSerializer

Throws:

SAXException

endElementImpl

public void endElementImpl(String uri,
                           String local,
                           String qual)
                    throws SAXException

Overrides:

endElementImpl in class XHTMLSerializer

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class EncodingSerializer

Throws:

SAXException

isMetaContentType

private boolean isMetaContentType(String local,
                                  String[][] attributes)

isJsScript

private boolean isJsScript(String local,
                           String[][] attributes)

recycle

public void recycle()

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class XMLSerializer