org.ametys.plugins.webcontentio.xml

Class XmlContentImporter

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.webcontentio.xml.XmlContentImporter

All Implemented Interfaces:

ContentImporter, LogEnabled, Serviceable

public class XmlContentImporter
extends AbstractLogEnabled
implements ContentImporter, Serviceable

Default XML content importer

Field Summary

Fields

Modifier and Type	Field and Description
private ContentTypesHelper	_cTypeHelper
private DOMParser	_domParser
private XPathProcessor	_xPathProcessor

Constructor Summary

Constructors

Constructor and Description
XmlContentImporter()

Method Summary

Modifier and Type	Method and Description
private void	_importMetadata(ModifiableCompositeMetadata contentNode, MetadataDefinition metaDef, Node domNode)
private void	_importMetadata(ModifiableWebContent content, Node domNode)
private void	_setMetadata(ModifiableCompositeMetadata contentNode, MetadataDefinition metaDef, Node domNode)
private void	_setRepeater(ModifiableCompositeMetadata meta, RepeaterDefinition repeaterDef, Node domNode)
private String[]	getMetadataValues(MetadataDefinition metaDef, Node domNode)
String[]	getMimeTypes() Returns all mime types handled by this importer.
private Document	getXmlDocFromFile(File file)
void	importContent(File file, ModifiableWebContent content, Map<String,String> params) Extracts file content and populates the given Content.
protected Date	parseDate(String value) Parse a String value as a Date. Allowed formats: yyyy-MM-dd yyyy-MM-dd'T'HH:mm:ss.SSSZZ
protected Date	parseDate(String value, boolean throwException) Parse a String value as a Date. Allowed formats: yyyy-MM-dd yyyy-MM-dd'T'HH:mm:ss.SSSZZ
void	postTreatment(ModifiablePage page, Content content, File file) Post treatment after import process
protected String	serializeNode(Node node) Serialize a XML node as a String.
void	service(ServiceManager manager)
protected void	setBinaryMetadata(ModifiableCompositeMetadata meta, MetadataDefinition metaDef, String value) Set a file metadata.
protected void	setBooleanMetadata(ModifiableCompositeMetadata meta, MetadataDefinition metaDef, String[] values) Set a boolean metadata.
protected void	setCompositeMetadata(ModifiableCompositeMetadata meta, MetadataDefinition metaDef, Node domNode) Set a composite metadata.
protected void	setDateMetadata(ModifiableCompositeMetadata meta, MetadataDefinition metaDef, String[] values) Set a date or datetime metadata.
protected void	setDoubleMetadata(ModifiableCompositeMetadata meta, MetadataDefinition metaDef, String[] values) Set a double metadata.
protected void	setGeocodeMetadata(ModifiableCompositeMetadata meta, MetadataDefinition metaDef, String latitude, String longitude) Set a geocode metadata.
protected void	setLongMetadata(ModifiableCompositeMetadata meta, MetadataDefinition metaDef, String[] values) Set a long metadata.
protected void	setRichTextMetadata(ModifiableCompositeMetadata meta, Node domNode, String name) Set a RichText metadata.
private void	setStringMetadata(ModifiableCompositeMetadata meta, MetadataDefinition metaDef, String[] values)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_domParser

private DOMParser _domParser

_xPathProcessor

private XPathProcessor _xPathProcessor

_cTypeHelper

private ContentTypesHelper _cTypeHelper

Constructor Detail

XmlContentImporter

public XmlContentImporter()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

importContent

public void importContent(File file,
                          ModifiableWebContent content,
                          Map<String,String> params)
                   throws IOException

Description copied from interface: ContentImporter

Extracts file content and populates the given Content. Typical usage is to provide a newly created empty Content.

Specified by:

importContent in interface ContentImporter

Parameters:

file - the source.

content - the Content to be populated.

params - in/out params to set and get additional data to and from the importer.

Throws:

IOException - if an error occurs processing the stream.

getMimeTypes

public String[] getMimeTypes()

Description copied from interface: ContentImporter

Returns all mime types handled by this importer.

Specified by:

getMimeTypes in interface ContentImporter

Returns:

all mime types handled by this importer.

postTreatment

public void postTreatment(ModifiablePage page,
                          Content content,
                          File file)
                   throws IOException

Description copied from interface: ContentImporter

Post treatment after import process

Specified by:

postTreatment in interface ContentImporter

Parameters:

page - The created page

content - The created content

file - The imported file

Throws:

IOException - if an error occurred

getXmlDocFromFile

private Document getXmlDocFromFile(File file)
                            throws FileNotFoundException,
                                   UnsupportedEncodingException,
                                   IOException

Throws:

FileNotFoundException

UnsupportedEncodingException

IOException

_importMetadata

private void _importMetadata(ModifiableWebContent content,
                             Node domNode)
                      throws IOException

Throws:

IOException

_importMetadata

private void _importMetadata(ModifiableCompositeMetadata contentNode,
                             MetadataDefinition metaDef,
                             Node domNode)
                      throws IOException

Throws:

IOException

_setRepeater

private void _setRepeater(ModifiableCompositeMetadata meta,
                          RepeaterDefinition repeaterDef,
                          Node domNode)
                   throws IOException

Throws:

IOException

_setMetadata

private void _setMetadata(ModifiableCompositeMetadata contentNode,
                          MetadataDefinition metaDef,
                          Node domNode)
                   throws IOException

Throws:

IOException

getMetadataValues

private String[] getMetadataValues(MetadataDefinition metaDef,
                                   Node domNode)

setStringMetadata

private void setStringMetadata(ModifiableCompositeMetadata meta,
                               MetadataDefinition metaDef,
                               String[] values)

setBooleanMetadata

protected void setBooleanMetadata(ModifiableCompositeMetadata meta,
                                  MetadataDefinition metaDef,
                                  String[] values)

Set a boolean metadata.

Parameters:

meta - the metadata holder.

metaDef - the metadata definition.

values - the metadata values.

setLongMetadata

protected void setLongMetadata(ModifiableCompositeMetadata meta,
                               MetadataDefinition metaDef,
                               String[] values)

Set a long metadata.

Parameters:

meta - the metadata holder.

metaDef - the metadata definition.

values - the metadata values.

setDoubleMetadata

protected void setDoubleMetadata(ModifiableCompositeMetadata meta,
                                 MetadataDefinition metaDef,
                                 String[] values)

Set a double metadata.

Parameters:

meta - the metadata holder.

metaDef - the metadata definition.

values - the metadata values.

setDateMetadata

protected void setDateMetadata(ModifiableCompositeMetadata meta,
                               MetadataDefinition metaDef,
                               String[] values)

Set a date or datetime metadata.

Parameters:

meta - the metadata holder.

metaDef - the metadata definition.

values - the metadata values.

parseDate

protected Date parseDate(String value)

Parse a String value as a Date.
Allowed formats:

• yyyy-MM-dd
• yyyy-MM-dd'T'HH:mm:ss.SSSZZ

Parameters:

value - the String value.

Returns:

the parsed Date or null if the value can't be parsed.

parseDate

protected Date parseDate(String value,
                         boolean throwException)

Parse a String value as a Date.
Allowed formats:

• yyyy-MM-dd
• yyyy-MM-dd'T'HH:mm:ss.SSSZZ

Parameters:

value - the String value.

throwException - true to throw an exception if the value can't be parsed, false to return null.

Returns:

the parsed Date or null if the value can't be parsed and throwException is false.

setGeocodeMetadata

protected void setGeocodeMetadata(ModifiableCompositeMetadata meta,
                                  MetadataDefinition metaDef,
                                  String latitude,
                                  String longitude)

Set a geocode metadata.

Parameters:

meta - the metadata holder.

metaDef - the metadata definition.

latitude - the geocode latitude as a String.

longitude - the geocode longitude as a String.

setCompositeMetadata

protected void setCompositeMetadata(ModifiableCompositeMetadata meta,
                                    MetadataDefinition metaDef,
                                    Node domNode)
                             throws IOException

Set a composite metadata.

Parameters:

meta - the metadata holder.

domNode - the metadata DOM node.

metaDef - the metadata definition.

Throws:

IOException - If an error occurres

setBinaryMetadata

protected void setBinaryMetadata(ModifiableCompositeMetadata meta,
                                 MetadataDefinition metaDef,
                                 String value)

Set a file metadata.

Parameters:

meta - the metadata holder.

metaDef - The metadata definition

value - The value

setRichTextMetadata

protected void setRichTextMetadata(ModifiableCompositeMetadata meta,
                                   Node domNode,
                                   String name)
                            throws IOException

Set a RichText metadata.

Parameters:

meta - the metadata holder.

domNode - the metadata node.

name - the metadata name.

Throws:

IOException - if an error occurs.

serializeNode

protected String serializeNode(Node node)
                        throws TransformerException

Serialize a XML node as a String.

Parameters:

node - the node.

Returns:

the XML string.

Throws:

TransformerException - if an error occurs.