org.ametys.plugins.repository.metadata

Class MetadataSaxer

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.repository.metadata.MetadataSaxer

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

MetadataManager

public class MetadataSaxer
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Component for helping SAXing metadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_context The avalon context.
protected JSONUtils	_jsonUtils The JSON conversion utilities.
protected AmetysObjectResolver	_resolver Ametys object resolver
protected UserManager	_userManager The user manager
static String	ROLE The Avalon Role.

Constructor Summary

Constructors

Constructor and Description
MetadataSaxer()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	_binaryAsJson(BinaryMetadata binaryMetadata, String prefix, String metadataName) Get the JSON representation of a BinaryMetadata
protected List<String>	_getRefAmetysObjectIds(TraversableAmetysObject objectCollection) Get the id of child Ametys objects
protected void	_saxAllMetadata(ContentHandler contentHandler, CompositeMetadata metadata, String prefix, Locale locale) SAX all the metadata of a given composite metadata, with the given prefix.
protected void	_saxBinaryMetadata(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName, String prefix) SAX a binary metadata.
protected void	_saxDateMetadata(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName, String prefix) SAX a metadata as a Date.
protected void	_saxEnumeratedStringMetadata(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName, Enumerator enumerator) SAX a string metadata.
protected void	_saxMetadata(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName, String prefix, Locale locale) SAX a single metadata.
protected void	_saxMultilingualStringMetadata(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName, String prefix, Locale currentLocale) SAX a multilingual string metadata.
protected void	_saxMultipleUserMetadataAsJson(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName) SAX a metadata as a User as JSON.
protected void	_saxObject(ContentHandler contentHandler, AmetysObject object, String prefix, boolean isDeep, Locale locale) SAX an Object, i.e.
protected void	_saxRichTextMetadata(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName, String prefix) SAX a rich-text metadata.
protected void	_saxSingleUserMetadataAsJson(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName) SAX a metadata as a User as JSON.
protected void	_saxStringMetadata(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName, String prefix) SAX a string metadata.
protected void	_saxUserMetadata(ContentHandler contentHandler, CompositeMetadata parentMetadata, String metadataName) SAX a metadata as a User.
protected Map<String,Object>	_userAsJson(UserIdentity userIdentity) Get the JSON representation of a User metadata
void	contextualize(Context context)
void	saxMetadata(ContentHandler contentHandler, CompositeMetadata compositeMetadata) SAXes a composite metadata.
void	saxMetadata(ContentHandler contentHandler, CompositeMetadata compositeMetadata, Locale locale) SAXes a composite metadata.
void	service(ServiceManager manager)

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

ROLE

public static final String ROLE

The Avalon Role.

_jsonUtils

protected JSONUtils _jsonUtils

The JSON conversion utilities.

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_context

protected Context _context

The avalon context.

_userManager

protected UserManager _userManager

The user manager

Constructor Detail

MetadataSaxer

public MetadataSaxer()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

saxMetadata

public void saxMetadata(ContentHandler contentHandler,
                        CompositeMetadata compositeMetadata)
                 throws AmetysRepositoryException,
                        SAXException,
                        IOException

SAXes a composite metadata.

Parameters:

contentHandler - the content handler where to SAX into.

compositeMetadata - the composite metadata.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.

saxMetadata

public void saxMetadata(ContentHandler contentHandler,
                        CompositeMetadata compositeMetadata,
                        Locale locale)
                 throws AmetysRepositoryException,
                        SAXException,
                        IOException

SAXes a composite metadata.

Parameters:

contentHandler - the content handler where to SAX into.

compositeMetadata - the composite metadata.

locale - The locale to use for localized metadata, such as MultilingualString. Can be null to sax all existing locales.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.

_saxAllMetadata

protected void _saxAllMetadata(ContentHandler contentHandler,
                               CompositeMetadata metadata,
                               String prefix,
                               Locale locale)
                        throws AmetysRepositoryException,
                               SAXException,
                               IOException

SAX all the metadata of a given composite metadata, with the given prefix.

Parameters:

contentHandler - the content handler where to SAX into.

metadata - the composite metadata.

prefix - the metadata path prefix.

locale - The locale to use for localized metadata, such as MultilingualString. Can be null to sax all existing locales.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.

_saxMetadata

protected void _saxMetadata(ContentHandler contentHandler,
                            CompositeMetadata parentMetadata,
                            String metadataName,
                            String prefix,
                            Locale locale)
                     throws AmetysRepositoryException,
                            SAXException,
                            IOException

SAX a single metadata.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

prefix - the metadata path prefix.

locale - The locale to use for localized metadata, such as MultilingualString. Can be null to sax all existing locales.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.

_saxBinaryMetadata

protected void _saxBinaryMetadata(ContentHandler contentHandler,
                                  CompositeMetadata parentMetadata,
                                  String metadataName,
                                  String prefix)
                           throws AmetysRepositoryException,
                                  SAXException

SAX a binary metadata.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

prefix - the metadata path prefix.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

_saxRichTextMetadata

protected void _saxRichTextMetadata(ContentHandler contentHandler,
                                    CompositeMetadata parentMetadata,
                                    String metadataName,
                                    String prefix)
                             throws AmetysRepositoryException,
                                    SAXException,
                                    IOException

SAX a rich-text metadata.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

prefix - the metadata path prefix.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.

_saxStringMetadata

protected void _saxStringMetadata(ContentHandler contentHandler,
                                  CompositeMetadata parentMetadata,
                                  String metadataName,
                                  String prefix)
                           throws AmetysRepositoryException,
                                  SAXException

SAX a string metadata.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

prefix - the metadata path prefix.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

_saxMultilingualStringMetadata

protected void _saxMultilingualStringMetadata(ContentHandler contentHandler,
                                              CompositeMetadata parentMetadata,
                                              String metadataName,
                                              String prefix,
                                              Locale currentLocale)
                                       throws AmetysRepositoryException,
                                              SAXException

SAX a multilingual string metadata.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

prefix - the metadata path prefix

currentLocale - The current locale. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

_saxEnumeratedStringMetadata

protected void _saxEnumeratedStringMetadata(ContentHandler contentHandler,
                                            CompositeMetadata parentMetadata,
                                            String metadataName,
                                            Enumerator enumerator)
                                     throws AmetysRepositoryException,
                                            SAXException

SAX a string metadata.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

enumerator - The enumerator for labelisable values

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

_saxDateMetadata

protected void _saxDateMetadata(ContentHandler contentHandler,
                                CompositeMetadata parentMetadata,
                                String metadataName,
                                String prefix)
                         throws AmetysRepositoryException,
                                SAXException

SAX a metadata as a Date.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

prefix - the metadata path prefix.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

_saxUserMetadata

protected void _saxUserMetadata(ContentHandler contentHandler,
                                CompositeMetadata parentMetadata,
                                String metadataName)
                         throws SAXException

SAX a metadata as a User.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

Throws:

SAXException - if an error occurs

_saxSingleUserMetadataAsJson

protected void _saxSingleUserMetadataAsJson(ContentHandler contentHandler,
                                            CompositeMetadata parentMetadata,
                                            String metadataName)
                                     throws SAXException

SAX a metadata as a User as JSON.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

Throws:

SAXException - if an error occurs

_saxMultipleUserMetadataAsJson

protected void _saxMultipleUserMetadataAsJson(ContentHandler contentHandler,
                                              CompositeMetadata parentMetadata,
                                              String metadataName)
                                       throws SAXException

SAX a metadata as a User as JSON.

Parameters:

contentHandler - the content handler where to SAX into.

parentMetadata - the parent composite metadata.

metadataName - the metadata name.

Throws:

SAXException - if an error occurs

_saxObject

protected void _saxObject(ContentHandler contentHandler,
                          AmetysObject object,
                          String prefix,
                          boolean isDeep,
                          Locale locale)
                   throws AmetysRepositoryException,
                          IOException,
                          SAXException

SAX an Object, i.e. its ID and name, and optionally its metadata.

Parameters:

contentHandler - the content handler where to SAX into.

object - the AmetysObject to sax.

prefix - the metadata path prefix.

isDeep - If true and the AmetysObject is a MetadataAwareAmetysObject, its metadata will be saxed.

locale - The locale to use for localized metadata, such as MultilingualString. Can be null to sax all existing locales.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.

_getRefAmetysObjectIds

protected List<String> _getRefAmetysObjectIds(TraversableAmetysObject objectCollection)

Get the id of child Ametys objects

Parameters:

objectCollection - The parent object collection

Returns:

The id of child Ametys objects

_userAsJson

protected Map<String,Object> _userAsJson(UserIdentity userIdentity)

Get the JSON representation of a User metadata

Parameters:

userIdentity - The user identity

Returns:

The user as JSON

_binaryAsJson

protected Map<String,Object> _binaryAsJson(BinaryMetadata binaryMetadata,
                                           String prefix,
                                           String metadataName)

Get the JSON representation of a BinaryMetadata

Parameters:

binaryMetadata - The metadata

prefix - The prefix

metadataName - The metadata name

Returns:

The binary as JSON