Package org.ametys.cms.content

Class ContentExtractor

java.lang.Object

org.ametys.cms.content.ContentExtractor

All Implemented Interfaces:

Component, Serviceable

Direct Known Subclasses:

ContentExtractor

public class ContentExtractor
extends Object
implements Component, Serviceable

Component responsible to extract a Content from an XML document.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CMS_CONTENT_EXTACTOR_ROLE	Avalon role.

Constructor Summary

Constructors

Constructor	Description
ContentExtractor()

Method Summary

Modifier and Type	Method	Description
protected Boolean	booleanValue(org.apache.xpath.objects.XObject xObject)	Consumes an XObject to retrieve the value as a Boolean
protected Date	dateValue(org.apache.xpath.objects.XObject xObject)	Consumes an XObject to retrieve the value as a Date
protected void	fillAttributes(ModifiableContent content, Node contentNode, XMLValuesExtractorAdditionalDataGetter additionalDataGetter)	Fills the given content with the attributes from the provided Node
protected void	fillComment(Comment comment, Node commentNode)	Fills the given comment with the values from the provided Node
void	fillContent(ModifiableContent content, Node node, XMLValuesExtractorAdditionalDataGetter additionalDataGetter)	Fills the given content with the values from the provided Node.
protected void	fillContentComments(Node contentNode, String commentsNodesName, BiFunction<String,ZonedDateTime,Comment> createCommentFunction)	Fills the content with the comments from the provided Node
protected void	fillDublinCore(ModifiableDublinCoreAwareAmetysObject dcObject, Node node)	Fills the given object with the dublin core values from the provided Node.
protected void	fillReactions(ReactionableObject reactionable, Node node)	Fills the given ReactionableObject with the reactions from the provided Node
protected void	fillReports(ReportableObject reportable, Node node)	Fills the given ReportableObject with the reports from the provided Node
void	service(ServiceManager manager)
protected <T> void	setIfNotNull(Node node, String expression, LambdaUtils.ThrowingFunction<org.apache.xpath.objects.XObject,T> retriever, Consumer<T> setter)	Sets a value through the given setter if the value is not null
protected String[]	values(org.apache.xpath.objects.XObject xObject)	Consumes an XObject to retrieve the value as a String array

Methods inherited from class java.lang.Object

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

Field Details

CMS_CONTENT_EXTACTOR_ROLE

public static final String CMS_CONTENT_EXTACTOR_ROLE

Avalon role.

Constructor Details

ContentExtractor

public ContentExtractor()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

fillContent

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

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.

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

fillDublinCore

protected void fillDublinCore(ModifiableDublinCoreAwareAmetysObject dcObject,
 Node node)
                       throws Exception

Fills the given object with the dublin core values from the provided Node.

Parameters:

dcObject - The object to fill

node - The node to read to get the values to fill

Throws:

Exception - if an exception occurs

fillContentComments

protected void fillContentComments(Node contentNode,
 String commentsNodesName,
 BiFunction<String,ZonedDateTime,Comment> createCommentFunction)
                            throws Exception

Fills the content with the comments from the provided Node

Parameters:

contentNode - the node to read to get the comments' values

commentsNodesName - the name of comments nodes

createCommentFunction - the function to use to create comments on the content

Throws:

Exception - if an error occurs

fillComment

protected void fillComment(Comment comment,
 Node commentNode)
                    throws Exception

Fills the given comment with the values from the provided Node

Parameters:

comment - The comment to fill

commentNode - the node to read to get the comment's values

Throws:

Exception - if an error occurs

fillReactions

protected void fillReactions(ReactionableObject reactionable,
 Node node)
                      throws Exception

Fills the given ReactionableObject with the reactions from the provided Node

Parameters:

reactionable - The ReactionableObject to fill

node - the node to read to get the reactions

Throws:

Exception - if an error occurs

fillReports

protected void fillReports(ReportableObject reportable,
 Node node)
                    throws Exception

Fills the given ReportableObject with the reports from the provided Node

Parameters:

reportable - The ReportableObject to fill

node - the node to read to get the reports

Throws:

Exception - if an error occurs

fillAttributes

protected void fillAttributes(ModifiableContent content,
 Node contentNode,
 XMLValuesExtractorAdditionalDataGetter additionalDataGetter)
                       throws Exception

Fills the given content with the attributes from the provided Node

Parameters:

content - The content to fill

contentNode - the node to read to get the attributes

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

Throws:

Exception - if an error occurs

setIfNotNull

protected <T> void setIfNotNull(Node node,
 String expression,
 LambdaUtils.ThrowingFunction<org.apache.xpath.objects.XObject,T> retriever,
 Consumer<T> setter)
                         throws Exception

Sets a value through the given setter if the value is not null

Type Parameters:

T - The type of the value to set

Parameters:

node - The node to read to get the value

expression - The expression to apply on the node to get the value

retriever - The Function that will retrieve the typed value from the XObject evaluated from the expression

setter - The Consumer that will be used to set the value

Throws:

Exception - if an error occurs

dateValue

protected Date dateValue(org.apache.xpath.objects.XObject xObject)

Consumes an XObject to retrieve the value as a Date

Parameters:

xObject - The consumed XObject

Returns:

The Date value

booleanValue

protected Boolean booleanValue(org.apache.xpath.objects.XObject xObject)

Consumes an XObject to retrieve the value as a Boolean

Parameters:

xObject - The consumed XObject

Returns:

The Boolean value

values

protected String[] values(org.apache.xpath.objects.XObject xObject)
                   throws TransformerException

Consumes an XObject to retrieve the value as a String array

Parameters:

xObject - The consumed XObject

Returns:

The String array

Throws:

TransformerException - if an error occurs