Package org.ametys.plugins.newsletter.content

Class ContentSaxer

java.lang.Object

org.ametys.cms.content.ContentSaxer

org.ametys.web.content.ContentSaxer

org.ametys.plugins.newsletter.content.ContentSaxer

All Implemented Interfaces:

Component, Serviceable

public class ContentSaxer
extends ContentSaxer

Generates SAX events for Content, including category, automatic and sent for Newsletters. TODO NEWATTRIBUTEAPI_CONTENT: do no use type implementation but the ModelAwareDataHolder#getInternalValue when this API exist

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__AUTOMATIC_METADATA_NAME
private static String	__AUTOMATIC_TAG_NAME
private static String	__CATEGORY_METADATA_NAME
private static String	__CATEGORY_TAG_NAME
private static String	__SENT_METADATA_NAME
private static String	__SENT_TAG_NAME
private ContentAttributeTypeExtensionPoint	_contentAttributeTypeExtensionPoint

Fields inherited from class org.ametys.cms.content.ContentSaxer

ROLE

Constructor Summary

Constructors

Constructor	Description
ContentSaxer()

Method Summary

Modifier and Type	Method	Description
protected void	fillAutomatic(ModifiableContent content, Element contentElement)	Fills the given newsletter with the automatic status from the provided Element
protected void	fillCategory(ModifiableContent content, Element contentElement)	Fills the given newsletter with the category from the provided Element
void	fillContent(ModifiableContent content, Node node, XMLValuesExtractorAdditionalDataGetter additionalDataGetter)	Fills the given content with the values from the provided Node.
protected void	fillSent(ModifiableContent content, Element contentElement)	Fills the given newsletter with the sent status from the provided Element
protected void	saxAutomatic(Content content, ContentHandler contentHandler)	Generates SAX events for the newsletter's automatic status.
protected void	saxBody(Content content, ContentHandler contentHandler, Locale locale, View view, String tagName, boolean saxWorkflowStep, boolean saxWorkflowInfo, boolean saxLanguageInfo, String attributesTagName)	Generates SAX events for the content data.
protected void	saxCategory(Content content, ContentHandler contentHandler)	Generates SAX events for the newsletter's category.
protected void	saxSent(Content content, ContentHandler contentHandler)	Generates SAX events for the newsletter's sent status.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.web.content.ContentSaxer

fillSiteName, fillTags, saxSiteName, saxTags

Methods inherited from class org.ametys.cms.content.ContentSaxer

booleanValue, dateValue, fillAttributes, fillComment, fillContentComments, fillDublinCore, fillReactions, fillReports, getCurrentStep, saxAttributes, saxComment, saxComments, saxContent, saxContentComments, saxContentTypes, saxDublinCoreMetadata, saxIfNotNull, saxIfNotNull, saxIfNotNull, saxLanguage, saxReactions, saxReports, saxRootTag, saxWorkflowStep, setIfNotNull, values

Methods inherited from class java.lang.Object

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

Field Detail

__CATEGORY_METADATA_NAME

private static final String __CATEGORY_METADATA_NAME

See Also:

Constant Field Values

__CATEGORY_TAG_NAME

private static final String __CATEGORY_TAG_NAME

See Also:

Constant Field Values

__AUTOMATIC_METADATA_NAME

private static final String __AUTOMATIC_METADATA_NAME

See Also:

Constant Field Values

__AUTOMATIC_TAG_NAME

private static final String __AUTOMATIC_TAG_NAME

See Also:

Constant Field Values

__SENT_METADATA_NAME

private static final String __SENT_METADATA_NAME

See Also:

Constant Field Values

__SENT_TAG_NAME

private static final String __SENT_TAG_NAME

See Also:

Constant Field Values

_contentAttributeTypeExtensionPoint

private ContentAttributeTypeExtensionPoint _contentAttributeTypeExtensionPoint

Constructor Detail

ContentSaxer

public ContentSaxer()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ContentSaxer

Throws:

ServiceException

saxBody

protected void saxBody(Content content,
                       ContentHandler contentHandler,
                       Locale locale,
                       View view,
                       String tagName,
                       boolean saxWorkflowStep,
                       boolean saxWorkflowInfo,
                       boolean saxLanguageInfo,
                       String attributesTagName)
                throws SAXException

Description copied from class: ContentSaxer

Generates SAX events for the content data.

Overrides:

saxBody in class ContentSaxer

Parameters:

content - the Content.

contentHandler - the ContentHandler receving SAX events.

locale - the Locale to use for eg. multilingual attributes.

view - the View or null to select all attributes.

tagName - the surrounding tag name or null to SAX events without root tag.

saxWorkflowStep - if true, also produces SAX events for the current workflow step.

saxWorkflowInfo - if true, also produces SAX events for detailed information about the current workflow step.

saxLanguageInfo - if true, also produces SAX events for detailed information about the content language.

attributesTagName - the name of the tag surrounding attributes. Used for legacy purposes.

Throws:

SAXException - if an error occurs during the SAX events generation.

saxCategory

protected void saxCategory(Content content,
                           ContentHandler contentHandler)
                    throws SAXException

Generates SAX events for the newsletter's category.

Parameters:

content - the newsletter

contentHandler - the ContentHandler receiving SAX events.

Throws:

SAXException - if an error occurs during the SAX events generation.

saxAutomatic

protected void saxAutomatic(Content content,
                            ContentHandler contentHandler)
                     throws SAXException

Generates SAX events for the newsletter's automatic status.

Parameters:

content - the newsletter

contentHandler - the ContentHandler receiving SAX events.

Throws:

SAXException - if an error occurs during the SAX events generation.

saxSent

protected void saxSent(Content content,
                       ContentHandler contentHandler)
                throws SAXException

Generates SAX events for the newsletter's sent status.

Parameters:

content - the newsletter

contentHandler - the ContentHandler receiving SAX events.

Throws:

SAXException - if an error occurs during the SAX events generation.

fillContent

public void fillContent(ModifiableContent content,
                        Node node,
                        XMLValuesExtractorAdditionalDataGetter additionalDataGetter)
                 throws Exception

Description copied from class: ContentSaxer

Fills the given content with the values from the provided Node.
This is the anti-operation of ContentSaxer.saxContent(org.ametys.cms.repository.Content, org.xml.sax.ContentHandler, java.util.Locale, org.ametys.runtime.model.View, java.lang.String, boolean, boolean, boolean, java.lang.String), as the org.w3c.dom.Node should be a Node previously generated with SAX events from this method.

Overrides:

fillContent in class ContentSaxer

Parameters:

content - The content to fill

node - The node to read for retrieving values to fill

additionalDataGetter - The object that will retrieve potential additional data for the content's attributes

Throws:

Exception - if an exception occurs

fillCategory

protected void fillCategory(ModifiableContent content,
                            Element contentElement)
                     throws TransformerException,
                            IOException

Fills the given newsletter with the category from the provided Element

Parameters:

content - The newsletter to fill

contentElement - the element to read to get the category

Throws:

TransformerException - if an error occurs

IOException - if an error occurs while reading the XML value

fillAutomatic

protected void fillAutomatic(ModifiableContent content,
                             Element contentElement)
                      throws TransformerException,
                             IOException

Fills the given newsletter with the automatic status from the provided Element

Parameters:

content - The newsletter to fill

contentElement - the element to read to get the automatic status

Throws:

TransformerException - if an error occurs

IOException - if an error occurs while reading the XML value

fillSent

protected void fillSent(ModifiableContent content,
                        Element contentElement)
                 throws TransformerException,
                        IOException

Fills the given newsletter with the sent status from the provided Element

Parameters:

content - The newsletter to fill

contentElement - the element to read to get the sent status

Throws:

TransformerException - if an error occurs

IOException - if an error occurs while reading the XML value