org.ametys.plugins.odfsync.cdmfr

Class MergeMetadataForSharedProgramHelper

java.lang.Object

org.ametys.plugins.odfsync.cdmfr.MergeMetadataForSharedProgramHelper

All Implemented Interfaces:

Component, Serviceable

public class MergeMetadataForSharedProgramHelper
extends Object
implements Serviceable, Component

Helper for synchronizing and merging metadata from shared programs

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentTypeExtensionPoint	_cTypeE The content type extension point
protected AmetysObjectResolver	_resolver The ametys object resolver
protected static XPathProcessor	_xPathProcessor The xpath processor
static String	ROLE The avalon role
static String	SHARED_PROGRAMS_NODE_NAME The name of the JCR node holding the shared metadata

Constructor Summary

Constructors

Constructor and Description
MergeMetadataForSharedProgramHelper()

Method Summary

Modifier and Type	Method and Description
protected String[]	getMergeSharedStringArrayMetadata(SubProgram mainSubProgram, String metadataName, Logger logger) Get and merge a String array shared metadata
ModifiableCompositeMetadata	getSharedMetadataHolder(SubProgram mainProgram, String subProgramCode, Logger logger) Get the composite metadata holding the shared metadata for subprogram of given code
Node	getSharedProgramRootNode(SubProgram mainProgram, Logger logger) Get the shared program node holding the shared subprogram node
boolean	isValidMetadataPath(ContentType cType, String metadataPath, Logger logger) Determines if the metadata path is a valid path from the given content type and eligible to merge
boolean	mergeSharedMetadata(SubProgram mainProgram, Node contentNode, Set<String> metadataToMerge, Logger logger) Merge the shared metadata
protected boolean	mergeSharedMultipleMetadata(MetadataDefinition metadataDefinition, SubProgram mainSubProgram, Node contentNode, String metadataName, Logger logger) Synchronize multiple metadata for main program
protected boolean	mergeSharedRepeaterMetadata(MetadataDefinition metadataDefinition, SubProgram mainSubProgram, String metadataName, Logger logger) Merge all repeater entry to the main program
protected boolean	mergeSharedSingleMetadata(MetadataDefinition metadataDefinition, SubProgram mainProgram, String metadataPath, Logger logger) Synchronize single metadata for main program
void	service(ServiceManager manager)

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

SHARED_PROGRAMS_NODE_NAME

public static final String SHARED_PROGRAMS_NODE_NAME

The name of the JCR node holding the shared metadata

See Also:

Constant Field Values

_xPathProcessor

protected static XPathProcessor _xPathProcessor

The xpath processor

_cTypeE

protected ContentTypeExtensionPoint _cTypeE

The content type extension point

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

Constructor Detail

MergeMetadataForSharedProgramHelper

public MergeMetadataForSharedProgramHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

mergeSharedMetadata

public boolean mergeSharedMetadata(SubProgram mainProgram,
                                   Node contentNode,
                                   Set<String> metadataToMerge,
                                   Logger logger)
                            throws RepositoryException

Merge the shared metadata

Parameters:

mainProgram - the main program

contentNode - The DOM representing the content

metadataToMerge - the metadata to merge

logger - the logger

Returns:

true if there are some changes

Throws:

RepositoryException - if an error occurred

mergeSharedMultipleMetadata

protected boolean mergeSharedMultipleMetadata(MetadataDefinition metadataDefinition,
                                              SubProgram mainSubProgram,
                                              Node contentNode,
                                              String metadataName,
                                              Logger logger)
                                       throws RepositoryException

Synchronize multiple metadata for main program

Parameters:

metadataDefinition - the metadata definition

mainSubProgram - the main subprogram

contentNode - The DOM representing the content

metadataName - the metadata name

logger - the logger

Returns:

true if there are some changes

Throws:

RepositoryException - if an error occurred

mergeSharedSingleMetadata

protected boolean mergeSharedSingleMetadata(MetadataDefinition metadataDefinition,
                                            SubProgram mainProgram,
                                            String metadataPath,
                                            Logger logger)
                                     throws RepositoryException

Synchronize single metadata for main program

Parameters:

metadataDefinition - the metadata definition

mainProgram - the main program

metadataPath - the metadata path

logger - the logger

Returns:

true if there are some changes

Throws:

RepositoryException - if an error occurred

getMergeSharedStringArrayMetadata

protected String[] getMergeSharedStringArrayMetadata(SubProgram mainSubProgram,
                                                     String metadataName,
                                                     Logger logger)
                                              throws RepositoryException

Get and merge a String array shared metadata

Parameters:

mainSubProgram - The main subprogram

metadataName - The metadata name

logger - the logger

Returns:

the merge metadata in a String array

Throws:

RepositoryException - if an error occurred

mergeSharedRepeaterMetadata

protected boolean mergeSharedRepeaterMetadata(MetadataDefinition metadataDefinition,
                                              SubProgram mainSubProgram,
                                              String metadataName,
                                              Logger logger)
                                       throws RepositoryException

Merge all repeater entry to the main program

Parameters:

metadataDefinition - the metadata definition

mainSubProgram - the main subprogram

metadataName - the metadata name

logger - the logger

Returns:

true if there are some changes

Throws:

RepositoryException - if an error occurred

getSharedProgramRootNode

public Node getSharedProgramRootNode(SubProgram mainProgram,
                                     Logger logger)
                              throws RepositoryException

Get the shared program node holding the shared subprogram node

Parameters:

mainProgram - the main program

logger - the logger

Returns:

root node

Throws:

RepositoryException - if an error occurred

getSharedMetadataHolder

public ModifiableCompositeMetadata getSharedMetadataHolder(SubProgram mainProgram,
                                                           String subProgramCode,
                                                           Logger logger)
                                                    throws RepositoryException

Get the composite metadata holding the shared metadata for subprogram of given code

Parameters:

mainProgram - the main program

subProgramCode - the sub program code

logger - the logger

Returns:

the shared composite metadata

Throws:

RepositoryException - if an error occurred

isValidMetadataPath

public boolean isValidMetadataPath(ContentType cType,
                                   String metadataPath,
                                   Logger logger)

Determines if the metadata path is a valid path from the given content type and eligible to merge

Parameters:

cType - The content type

metadataPath - The metadata path

logger - the logger

Returns:

true if the metadata can be merged