org.ametys.plugins.odfsync.cdmfr.components

Class AbstractImportCDMFrComponent

java.lang.Object

org.ametys.plugins.odfsync.cdmfr.components.AbstractImportCDMFrComponent

All Implemented Interfaces:

ImportCDMFrComponent, Initializable, Component, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

RemoteImportCDMFrComponent, SCCImportCDMFrComponent

public abstract class AbstractImportCDMFrComponent
extends Object
implements ImportCDMFrComponent, Serviceable, Initializable, Contextualizable, Configurable, Component

Abstract class of a component to import a CDM-fr input stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractImportCDMFrComponent.ContentWorkflowDescription Internal object to describe content workflow elements.
private static class	AbstractImportCDMFrComponent.DocbookPrefixResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected CatalogsManager	_catalogsManager The catalog manager
protected CDMFrSyncExtensionPoint	_cdmFrSyncExtensionPoint Extension point to transform CDM-fr
protected Context	_cocoonContext The Cocoon context
private static AbstractImportCDMFrComponent.ContentWorkflowDescription	_CONTAINER_WF_DESCRIPTION
protected String	_contentPrefix The prefix of the contents
protected ContentTypeExtensionPoint	_contentTypeEP The content type extension point
private static AbstractImportCDMFrComponent.ContentWorkflowDescription	_COURSE_WF_DESCRIPTION
private static AbstractImportCDMFrComponent.ContentWorkflowDescription	_COURSELIST_WF_DESCRIPTION
private static AbstractImportCDMFrComponent.ContentWorkflowDescription	_COURSEPART_WF_DESCRIPTION
protected CurrentUserProvider	_currentUserProvider The current user provider
protected DOMParser	_domParser The DOM parser
protected Map<String,Integer>	_importedContents List of synchronized contents
protected int	_nbCreatedContents Number of created contents
protected int	_nbError Number of errors encountered
protected int	_nbNotChangedContents Number of unchanged contents
protected int	_nbSynchronizedContents Number of synchronized contents
protected ObservationManager	_observationManager The observation manager
protected String	_odfLang Default language configured for ODF
protected OdfReferenceTableHelper	_odfRefTableHelper The ODF TableRef Helper
private static AbstractImportCDMFrComponent.ContentWorkflowDescription	_ORGUNIT_WF_DESCRIPTION
private static AbstractImportCDMFrComponent.ContentWorkflowDescription	_PERSON_WF_DESCRIPTION
private static PrefixResolver	_PREFIX_RESOLVER
private static AbstractImportCDMFrComponent.ContentWorkflowDescription	_PROGRAM_WF_DESCRIPTION
protected AmetysObjectResolver	_resolver The ametys object resolver
protected RootOrgUnitProvider	_rootOUProvider The root orgunit provider
protected ShareableCourseHelper	_shareableCourseHelper The shareable course helper
private static AbstractImportCDMFrComponent.ContentWorkflowDescription	_SUBPROGRAM_WF_DESCRIPTION
protected Map<String,Set<String>>	_syncFieldsByContentType Synchronized fields by content type
protected BaseSynchroComponent	_synchroComponent The base SCC component
protected Set<String>	_synchronizedContents List of synchronized contents having differences
protected static String	_TAG_CONTAINER Tag to identify a container
protected static String	_TAG_COURSELIST Tag to identify a courseList
protected static String	_TAG_COURSEPART Tag to identify a coursePart
protected static String	_TAG_PROGRAM Tag to identify a program
protected static String	_TAG_SUBPROGRAM Tag to identify a subprogram
protected Set<String>	_updatedContents List of synchronized contents (to avoid a treatment twice or more)
protected XPathProcessor	_xPathProcessor The XPath processor
private static int	SYNCHRONIZE_WORKFLOW_ACTION_ID The synchronize workflow action id

Fields inherited from interface org.ametys.plugins.odfsync.cdmfr.components.ImportCDMFrComponent

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractImportCDMFrComponent()

Method Summary

Modifier and Type	Method and Description
private Set<String>	_configureSynchronizedFields(Configuration configuration, String prefix)
private void	_fetchImages(Node docbookNode, ModifiableDefaultContent content, ModifiableRichText richText, String metadataPath, Logger logger)
protected ModifiableDefaultContent	_getContent(String lang, String catalog, String syncCode, AbstractImportCDMFrComponent.ContentWorkflowDescription wfDescription) Get the content from the synchronization code, the lang, the catalog and the content type.
protected String	_getIdFromCDMThenCode(String tableRefId, String cdmCode) Get the content ID from the CDM code, if there is no match with the CDM code, then we search with the code.
protected ModifiableDefaultContent	_getOrCreateContent(String title, String lang, String catalog, String syncCode, AbstractImportCDMFrComponent.ContentWorkflowDescription wfDescription, Logger logger) Get or create the content from the synchronization code, the lang, the catalog and the content type.
private String	_getXPathString(Node metadataNode, String xPath, String defaultValue)
protected boolean	_handleBinaryMetadata(Node metadataNode, ModifiableDefaultContent content, ModifiableCompositeMetadata metadataHolder, String metadataName, boolean synchronize, Logger logger) Synchronize binary metadata
protected boolean	_handleBinaryMetadata(Node metadataNode, ModifiableDefaultContent content, String completeMetadataPath, boolean synchronize, Logger logger) Synchronize binary metadata
private boolean	_handleCompositeMetadata(Document doc, Node metadataNode, ModifiableDefaultContent content, String logicalMetadataPath, String completeMetadataPath, ContentType contentType, String lang, String catalog, Logger logger)
protected boolean	_handleFileMetadata(Node metadataNode, ModifiableDefaultContent content, String logicalMetadataPath, ModifiableCompositeMetadata metadataHolder, String metadataName, boolean synchronize, ContentType contentType, Logger logger) Synchronize file metadata
protected boolean	_handleFileMetadata(Node metadataNode, ModifiableDefaultContent content, String logicalMetadataPath, String completeMetadataPath, boolean synchronize, ContentType contentType, Logger logger) Synchronize file metadata
protected boolean	_handleGeocodeMetadata(Node metadataNode, ModifiableDefaultContent content, ModifiableCompositeMetadata metadataHolder, String metadataName, boolean synchronize) Synchronize geocode metadata
protected boolean	_handleGeocodeMetadata(Node metadataNode, ModifiableDefaultContent content, String completeMetadataPath, boolean synchronize) Synchronize geocode metadata
protected List<Object>	_handleMetadataValues(Document doc, ModifiableDefaultContent content, MetadataDefinition metadataDef, List<String> metadataValues, String lang, String catalog, Logger logger) Handle metadata values
private Object	_handleMetadataValuesAsContent(Document doc, MetadataDefinition metadataDef, String metadataValue, String lang, String catalog, Logger logger)
private boolean	_handleRepeaterMetadata(Document doc, Node metadataNode, ModifiableDefaultContent content, String logicalMetadataPath, String completeMetadataPath, ContentType contentType, String lang, String catalog, Logger logger)
private boolean	_handleRichTextMetadata(ModifiableDefaultContent content, String logicalMetadataPath, String completeMetadataPath, Node metadataNode, boolean synchronize, Logger logger)
protected ModifiableDefaultContent	_importOrSynchronizeContent(Document doc, Node contentNode, AbstractImportCDMFrComponent.ContentWorkflowDescription wfDescription, String title, String lang, String catalog, String syncCode, Logger logger) Import or synchronize the content.
protected void	_linkTranslationsIfExist(ModifiableContent importedContent, String contentType) Search for translated contents
private void	_parseSynchronizedFields() Get the synchronized metadata from the configuration file
protected void	_saveContentChanges(ModifiableDefaultContent content, String contentTypeId, boolean hasChanges, Logger logger) Save the changes of the content.
protected boolean	_setChildren(ModifiableDefaultContent content, List<ModifiableDefaultContent> children, Logger logger) Set children for the given content.
protected boolean	_setOrgUnitParent(ModifiableDefaultContent orgUnit, Logger logger) Set the orgUnit parent to rootOrgUnit.
protected boolean	_setRelations(ModifiableDefaultContent content, List<ModifiableDefaultContent> children, List<ModifiableDefaultContent> courseParts, boolean removeOldCourseParts, Logger logger) Set relations for the content.
protected void	_synchronizeContent(Document doc, Node contentNode, ModifiableDefaultContent content, String contentTypeId, String lang, String catalog, String syncCode, Logger logger) Synchronize content
protected void	_synchronizeCourseList(Document doc, Node courseListNode, ModifiableDefaultContent courseList, String lang, String catalog, Logger logger) Synchronize a course list, it has attributes to synchronize.
protected boolean	_synchronizeMetadata(Document doc, Node metadataNode, ModifiableDefaultContent content, String logicalMetadataPath, String completeMetadataPath, ContentType contentType, String lang, String catalog, Logger logger) Synchronize a metadata (can be a composite or a repeater).
private boolean	_updateDoubleRelation(ModifiableDefaultContent content, List<ModifiableDefaultContent> children, String metadataName, String invertMetadataName, Logger logger)
protected abstract void	additionalOperationsBeforeSave(ModifiableDefaultContent content, Logger logger) Additional operation to do on the content before saving it.
protected abstract void	additionalParameters(Map<String,Object> parameters) Additional parameters for specific treatments.
void	configure(Configuration configuration)
void	contextualize(Context context)
protected String	getCatalogName(Node contentNode) Get the name of catalog to use for import
protected AbstractImportCDMFrComponent.ContentWorkflowDescription	getContainerWfDescription() Get the container workflow description.
protected AbstractImportCDMFrComponent.ContentWorkflowDescription	getCourseListWfDescription() Get the course list workflow description.
protected AbstractImportCDMFrComponent.ContentWorkflowDescription	getCoursePartWfDescription() Get the course part workflow description.
protected AbstractImportCDMFrComponent.ContentWorkflowDescription	getCourseWfDescription() Get the course workflow description.
List<Expression>	getExpressionsList(String lang, String idValue, String contentType, String catalog) Construct the query to retrieve the content.
String	getIdField() Return the metadata identifier for CDM-fr synchronization.
Set<String>	getLocalAndExternalFields(Map<String,Object> additionalParameters) Get the path of tri-state fields (with local and external values)
protected AbstractImportCDMFrComponent.ContentWorkflowDescription	getOrgUnitWfDescription() Get the orgunit workflow description.
protected AbstractImportCDMFrComponent.ContentWorkflowDescription	getPersonWfDescription() Get the person workflow description.
protected AbstractImportCDMFrComponent.ContentWorkflowDescription	getProgramWfDescription() Get the program workflow description.
protected AbstractImportCDMFrComponent.ContentWorkflowDescription	getSubProgramWfDescription() Get the subprogram workflow description.
Map<String,Object>	handleInputStream(InputStream input, Map<String,Object> parameters, Logger logger) Handle the CDM-fr input stream to import all the programs and its dependencies containing into it.
protected boolean	ignoreRights() If true, bypass the rights check during the import process
void	initialize()
protected abstract boolean	removalSync() When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.
void	service(ServiceManager manager)
protected Document	transformDocument(Document document, Map<String,Object> parameters, Logger logger) Transform the document depending of it structure.
protected abstract boolean	validateAfterImport() True to validate the contents after import

Methods inherited from class java.lang.Object

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

Field Detail

_TAG_PROGRAM

protected static final String _TAG_PROGRAM

Tag to identify a program

See Also:

Constant Field Values

_TAG_SUBPROGRAM

protected static final String _TAG_SUBPROGRAM

Tag to identify a subprogram

See Also:

Constant Field Values

_TAG_CONTAINER

protected static final String _TAG_CONTAINER

Tag to identify a container

See Also:

Constant Field Values

_TAG_COURSELIST

protected static final String _TAG_COURSELIST

Tag to identify a courseList

See Also:

Constant Field Values

_TAG_COURSEPART

protected static final String _TAG_COURSEPART

Tag to identify a coursePart

See Also:

Constant Field Values

SYNCHRONIZE_WORKFLOW_ACTION_ID

private static final int SYNCHRONIZE_WORKFLOW_ACTION_ID

The synchronize workflow action id

See Also:

Constant Field Values

_PROGRAM_WF_DESCRIPTION

private static final AbstractImportCDMFrComponent.ContentWorkflowDescription _PROGRAM_WF_DESCRIPTION

_SUBPROGRAM_WF_DESCRIPTION

private static final AbstractImportCDMFrComponent.ContentWorkflowDescription _SUBPROGRAM_WF_DESCRIPTION

_CONTAINER_WF_DESCRIPTION

private static final AbstractImportCDMFrComponent.ContentWorkflowDescription _CONTAINER_WF_DESCRIPTION

_COURSELIST_WF_DESCRIPTION

private static final AbstractImportCDMFrComponent.ContentWorkflowDescription _COURSELIST_WF_DESCRIPTION

_COURSE_WF_DESCRIPTION

private static final AbstractImportCDMFrComponent.ContentWorkflowDescription _COURSE_WF_DESCRIPTION

_COURSEPART_WF_DESCRIPTION

private static final AbstractImportCDMFrComponent.ContentWorkflowDescription _COURSEPART_WF_DESCRIPTION

_ORGUNIT_WF_DESCRIPTION

private static final AbstractImportCDMFrComponent.ContentWorkflowDescription _ORGUNIT_WF_DESCRIPTION

_PERSON_WF_DESCRIPTION

private static final AbstractImportCDMFrComponent.ContentWorkflowDescription _PERSON_WF_DESCRIPTION

_PREFIX_RESOLVER

private static final PrefixResolver _PREFIX_RESOLVER

_cocoonContext

protected Context _cocoonContext

The Cocoon context

_domParser

protected DOMParser _domParser

The DOM parser

_xPathProcessor

protected XPathProcessor _xPathProcessor

The XPath processor

_cdmFrSyncExtensionPoint

protected CDMFrSyncExtensionPoint _cdmFrSyncExtensionPoint

Extension point to transform CDM-fr

_odfLang

protected String _odfLang

Default language configured for ODF

_catalogsManager

protected CatalogsManager _catalogsManager

The catalog manager

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_odfRefTableHelper

protected OdfReferenceTableHelper _odfRefTableHelper

The ODF TableRef Helper

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The content type extension point

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_observationManager

protected ObservationManager _observationManager

The observation manager

_rootOUProvider

protected RootOrgUnitProvider _rootOUProvider

The root orgunit provider

_synchroComponent

protected BaseSynchroComponent _synchroComponent

The base SCC component

_shareableCourseHelper

protected ShareableCourseHelper _shareableCourseHelper

The shareable course helper

_importedContents

protected Map<String,Integer> _importedContents

List of synchronized contents

_synchronizedContents

protected Set<String> _synchronizedContents

List of synchronized contents having differences

_updatedContents

protected Set<String> _updatedContents

List of synchronized contents (to avoid a treatment twice or more)

_nbError

protected int _nbError

Number of errors encountered

_nbCreatedContents

protected int _nbCreatedContents

Number of created contents

_nbSynchronizedContents

protected int _nbSynchronizedContents

Number of synchronized contents

_nbNotChangedContents

protected int _nbNotChangedContents

Number of unchanged contents

_contentPrefix

protected String _contentPrefix

The prefix of the contents

_syncFieldsByContentType

protected Map<String,Set<String>> _syncFieldsByContentType

Synchronized fields by content type

Constructor Detail

AbstractImportCDMFrComponent

public AbstractImportCDMFrComponent()

Method Detail

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getIdField

public String getIdField()

Description copied from interface: ImportCDMFrComponent

Return the metadata identifier for CDM-fr synchronization.

Specified by:

getIdField in interface ImportCDMFrComponent

Returns:

The metadata name (cdmfrSyncCode)

_parseSynchronizedFields

private void _parseSynchronizedFields()
                               throws ConfigurationException

Get the synchronized metadata from the configuration file

Throws:

ConfigurationException - if the configuration is not valid.

_configureSynchronizedFields

private Set<String> _configureSynchronizedFields(Configuration configuration,
                                                 String prefix)
                                          throws ConfigurationException

Throws:

ConfigurationException

handleInputStream

public Map<String,Object> handleInputStream(InputStream input,
                                            Map<String,Object> parameters,
                                            Logger logger)
                                     throws ProcessingException

Description copied from interface: ImportCDMFrComponent

Handle the CDM-fr input stream to import all the programs and its dependencies containing into it.

Specified by:

handleInputStream in interface ImportCDMFrComponent

Parameters:

input - The CDM-fr input stream

parameters - The parameters useful for the operation

logger - The logger

Returns:

The list of imported/synchronized programs

Throws:

ProcessingException - If an error occurs

validateAfterImport

protected abstract boolean validateAfterImport()

True to validate the contents after import

Returns:

True to validate the contents after import

removalSync

protected abstract boolean removalSync()

When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.

Returns:

true if a content created by a previous synchro has to be removed if it does not exist anymore during the current synchro.

transformDocument

protected Document transformDocument(Document document,
                                     Map<String,Object> parameters,
                                     Logger logger)
                              throws IOException,
                                     SAXException,
                                     ProcessingException

Transform the document depending of it structure.

Parameters:

document - Document to transform.

parameters - Optional parameters for transformation

logger - The logger

Returns:

The transformed document.

Throws:

IOException - if an error occurs.

SAXException - if an error occurs.

ProcessingException - if an error occurs.

getCatalogName

protected String getCatalogName(Node contentNode)

Get the name of catalog to use for import

Parameters:

contentNode - The node of program

Returns:

The catalog to used

_getOrCreateContent

protected ModifiableDefaultContent _getOrCreateContent(String title,
                                                       String lang,
                                                       String catalog,
                                                       String syncCode,
                                                       AbstractImportCDMFrComponent.ContentWorkflowDescription wfDescription,
                                                       Logger logger)
                                                throws RepositoryException

Get or create the content from the synchronization code, the lang, the catalog and the content type.

Parameters:

title - The title

lang - The lang

catalog - The catalog

syncCode - The synchronization code

wfDescription - The workflow description

logger - The logger

Returns:

the retrieved or created content

Throws:

RepositoryException - if an error occurs

_getContent

protected ModifiableDefaultContent _getContent(String lang,
                                               String catalog,
                                               String syncCode,
                                               AbstractImportCDMFrComponent.ContentWorkflowDescription wfDescription)

Get the content from the synchronization code, the lang, the catalog and the content type.

Parameters:

lang - The lang

catalog - The catalog

syncCode - The synchronization code

wfDescription - The workflow description

Returns:

the retrieved content

additionalParameters

protected abstract void additionalParameters(Map<String,Object> parameters)

Additional parameters for specific treatments.

Parameters:

parameters - The parameters map to get

additionalOperationsBeforeSave

protected abstract void additionalOperationsBeforeSave(ModifiableDefaultContent content,
                                                       Logger logger)
                                                throws RepositoryException

Additional operation to do on the content before saving it.

Parameters:

content - The content

logger - The logger

Throws:

RepositoryException - if an error occurs

_importOrSynchronizeContent

protected ModifiableDefaultContent _importOrSynchronizeContent(Document doc,
                                                               Node contentNode,
                                                               AbstractImportCDMFrComponent.ContentWorkflowDescription wfDescription,
                                                               String title,
                                                               String lang,
                                                               String catalog,
                                                               String syncCode,
                                                               Logger logger)

Import or synchronize the content.

Parameters:

doc - XML document

contentNode - Node of the content

wfDescription - The workflow description

title - The title

lang - The lang

catalog - The catalog

syncCode - The synchronization code

logger - The logger

Returns:

The imported or synchronized content

_synchronizeContent

protected void _synchronizeContent(Document doc,
                                   Node contentNode,
                                   ModifiableDefaultContent content,
                                   String contentTypeId,
                                   String lang,
                                   String catalog,
                                   String syncCode,
                                   Logger logger)

Synchronize content

Parameters:

doc - The root document

contentNode - the DOM content node

content - The content to synchronize

contentTypeId - The content type ID

lang - Parent program language (to select the good courses in the CDM-FR file)

catalog - The catalog of parent program

syncCode - The synchronization code

logger - The logger

_synchronizeCourseList

protected void _synchronizeCourseList(Document doc,
                                      Node courseListNode,
                                      ModifiableDefaultContent courseList,
                                      String lang,
                                      String catalog,
                                      Logger logger)

Synchronize a course list, it has attributes to synchronize.

Parameters:

doc - The XML document

courseListNode - The XML node of the course list

courseList - The course list content

lang - The lang

catalog - The catalog

logger - The logger

_fetchImages

private void _fetchImages(Node docbookNode,
                          ModifiableDefaultContent content,
                          ModifiableRichText richText,
                          String metadataPath,
                          Logger logger)

_synchronizeMetadata

protected boolean _synchronizeMetadata(Document doc,
                                       Node metadataNode,
                                       ModifiableDefaultContent content,
                                       String logicalMetadataPath,
                                       String completeMetadataPath,
                                       ContentType contentType,
                                       String lang,
                                       String catalog,
                                       Logger logger)

Synchronize a metadata (can be a composite or a repeater).

Parameters:

doc - The XML document

metadataNode - The metadata node

content - The content

logicalMetadataPath - The logical metadata path (to retrieve the definition)

completeMetadataPath - The complete metadata path (to retrieve the metadata holder)

contentType - The content type

lang - The lang

catalog - The catalog

logger - The logger

Returns:

true if changes occurs

_handleGeocodeMetadata

protected boolean _handleGeocodeMetadata(Node metadataNode,
                                         ModifiableDefaultContent content,
                                         String completeMetadataPath,
                                         boolean synchronize)

Synchronize geocode metadata

Parameters:

metadataNode - The metadata node

content - The content

completeMetadataPath - The complete metadata path (to retrieve the metadata holder)

synchronize - true if the data is external

Returns:

true if some changes has been made

_handleGeocodeMetadata

protected boolean _handleGeocodeMetadata(Node metadataNode,
                                         ModifiableDefaultContent content,
                                         ModifiableCompositeMetadata metadataHolder,
                                         String metadataName,
                                         boolean synchronize)

Synchronize geocode metadata

Parameters:

metadataNode - The metadata node

content - The content

metadataHolder - the metadata holder

metadataName - the metadata name

synchronize - true if the data is external

Returns:

true if some changes has been made

_handleFileMetadata

protected boolean _handleFileMetadata(Node metadataNode,
                                      ModifiableDefaultContent content,
                                      String logicalMetadataPath,
                                      String completeMetadataPath,
                                      boolean synchronize,
                                      ContentType contentType,
                                      Logger logger)

Synchronize file metadata

Parameters:

metadataNode - The metadata node

content - The content

logicalMetadataPath - The logical metadata path (to retrieve the definition)

completeMetadataPath - The complete metadata path (to retrieve the metadata holder)

synchronize - true if the data is external

contentType - the content type

logger - the logger

Returns:

true if some changes has been made

_handleFileMetadata

protected boolean _handleFileMetadata(Node metadataNode,
                                      ModifiableDefaultContent content,
                                      String logicalMetadataPath,
                                      ModifiableCompositeMetadata metadataHolder,
                                      String metadataName,
                                      boolean synchronize,
                                      ContentType contentType,
                                      Logger logger)

Synchronize file metadata

Parameters:

metadataNode - The metadata node

content - The content

logicalMetadataPath - The logical metadata path (to retrieve the definition)

metadataHolder - the metadata holder

metadataName - the metadata name

synchronize - true if the data is external

contentType - the content type

logger - the logger

Returns:

true if some changes has been made

_handleBinaryMetadata

protected boolean _handleBinaryMetadata(Node metadataNode,
                                        ModifiableDefaultContent content,
                                        String completeMetadataPath,
                                        boolean synchronize,
                                        Logger logger)

Synchronize binary metadata

Parameters:

metadataNode - The metadata node

content - The content

completeMetadataPath - The complete metadata path (to retrieve the metadata holder)

synchronize - true if the data is external

logger - the logger

Returns:

true if some changes has been made

_handleBinaryMetadata

protected boolean _handleBinaryMetadata(Node metadataNode,
                                        ModifiableDefaultContent content,
                                        ModifiableCompositeMetadata metadataHolder,
                                        String metadataName,
                                        boolean synchronize,
                                        Logger logger)

Synchronize binary metadata

Parameters:

metadataNode - The metadata node

content - The content

metadataHolder - the metadata holder

metadataName - the metadata name

synchronize - true if the data is external

logger - the logger

Returns:

true if some changes has been made

_handleRepeaterMetadata

private boolean _handleRepeaterMetadata(Document doc,
                                        Node metadataNode,
                                        ModifiableDefaultContent content,
                                        String logicalMetadataPath,
                                        String completeMetadataPath,
                                        ContentType contentType,
                                        String lang,
                                        String catalog,
                                        Logger logger)

_handleCompositeMetadata

private boolean _handleCompositeMetadata(Document doc,
                                         Node metadataNode,
                                         ModifiableDefaultContent content,
                                         String logicalMetadataPath,
                                         String completeMetadataPath,
                                         ContentType contentType,
                                         String lang,
                                         String catalog,
                                         Logger logger)

_handleRichTextMetadata

private boolean _handleRichTextMetadata(ModifiableDefaultContent content,
                                        String logicalMetadataPath,
                                        String completeMetadataPath,
                                        Node metadataNode,
                                        boolean synchronize,
                                        Logger logger)

_handleMetadataValues

protected List<Object> _handleMetadataValues(Document doc,
                                             ModifiableDefaultContent content,
                                             MetadataDefinition metadataDef,
                                             List<String> metadataValues,
                                             String lang,
                                             String catalog,
                                             Logger logger)

Handle metadata values

Parameters:

doc - the document

content - the content

metadataDef - the metadata definition

metadataValues - the metadata values

lang - the language

catalog - the catalog

logger - the logger

Returns:

the list of handle values

_handleMetadataValuesAsContent

private Object _handleMetadataValuesAsContent(Document doc,
                                              MetadataDefinition metadataDef,
                                              String metadataValue,
                                              String lang,
                                              String catalog,
                                              Logger logger)

_linkTranslationsIfExist

protected void _linkTranslationsIfExist(ModifiableContent importedContent,
                                        String contentType)

Search for translated contents

Parameters:

importedContent - The imported content

contentType - The content type

_saveContentChanges

protected void _saveContentChanges(ModifiableDefaultContent content,
                                   String contentTypeId,
                                   boolean hasChanges,
                                   Logger logger)

Save the changes of the content.

Parameters:

content - Content to save

contentTypeId - The content type (for logs)

hasChanges - If there are changes to save

logger - The logger

_setRelations

protected boolean _setRelations(ModifiableDefaultContent content,
                                List<ModifiableDefaultContent> children,
                                List<ModifiableDefaultContent> courseParts,
                                boolean removeOldCourseParts,
                                Logger logger)

Set relations for the content.

Parameters:

content - The content to update

children - Children to set

courseParts - List of CoursePart to set for Course content

removeOldCourseParts - If the course parts doesn't have a code, we remove all the old CourseParts before adding the new ones

logger - The logger

Returns:

true if changes occurs

_setChildren

protected boolean _setChildren(ModifiableDefaultContent content,
                               List<ModifiableDefaultContent> children,
                               Logger logger)

Set children for the given content.

Parameters:

content - Content to add the children

children - Children to add

logger - The logger

Returns:

true if changes occurs

_setOrgUnitParent

protected boolean _setOrgUnitParent(ModifiableDefaultContent orgUnit,
                                    Logger logger)

Set the orgUnit parent to rootOrgUnit.

Parameters:

orgUnit - The orgunit to link

logger - The logger

Returns:

true if changes occurs

_getIdFromCDMThenCode

protected String _getIdFromCDMThenCode(String tableRefId,
                                       String cdmCode)

Get the content ID from the CDM code, if there is no match with the CDM code, then we search with the code. If nothing is found we return null.

Parameters:

tableRefId - The reference table ID

cdmCode - The CDM code

Returns:

A content ID or null

_updateDoubleRelation

private boolean _updateDoubleRelation(ModifiableDefaultContent content,
                                      List<ModifiableDefaultContent> children,
                                      String metadataName,
                                      String invertMetadataName,
                                      Logger logger)

_getXPathString

private String _getXPathString(Node metadataNode,
                               String xPath,
                               String defaultValue)

ignoreRights

protected boolean ignoreRights()

If true, bypass the rights check during the import process

Returns:

True if the rights check are bypassed during the import process

getProgramWfDescription

protected AbstractImportCDMFrComponent.ContentWorkflowDescription getProgramWfDescription()

Get the program workflow description.

Returns:

A AbstractImportCDMFrComponent.ContentWorkflowDescription containing informations about the program workflow

getSubProgramWfDescription

protected AbstractImportCDMFrComponent.ContentWorkflowDescription getSubProgramWfDescription()

Get the subprogram workflow description.

Returns:

A AbstractImportCDMFrComponent.ContentWorkflowDescription containing informations about the subprogram workflow

getContainerWfDescription

protected AbstractImportCDMFrComponent.ContentWorkflowDescription getContainerWfDescription()

Get the container workflow description.

Returns:

A AbstractImportCDMFrComponent.ContentWorkflowDescription containing informations about the container workflow

getCourseListWfDescription

protected AbstractImportCDMFrComponent.ContentWorkflowDescription getCourseListWfDescription()

Get the course list workflow description.

Returns:

A AbstractImportCDMFrComponent.ContentWorkflowDescription containing informations about the course list workflow

getCourseWfDescription

protected AbstractImportCDMFrComponent.ContentWorkflowDescription getCourseWfDescription()

Get the course workflow description.

Returns:

A AbstractImportCDMFrComponent.ContentWorkflowDescription containing informations about the course workflow

getCoursePartWfDescription

protected AbstractImportCDMFrComponent.ContentWorkflowDescription getCoursePartWfDescription()

Get the course part workflow description.

Returns:

A AbstractImportCDMFrComponent.ContentWorkflowDescription containing informations about the course part workflow

getOrgUnitWfDescription

protected AbstractImportCDMFrComponent.ContentWorkflowDescription getOrgUnitWfDescription()

Get the orgunit workflow description.

Returns:

A AbstractImportCDMFrComponent.ContentWorkflowDescription containing informations about the orgunit workflow

getPersonWfDescription

protected AbstractImportCDMFrComponent.ContentWorkflowDescription getPersonWfDescription()

Get the person workflow description.

Returns:

A AbstractImportCDMFrComponent.ContentWorkflowDescription containing informations about the person workflow

getExpressionsList

public List<Expression> getExpressionsList(String lang,
                                           String idValue,
                                           String contentType,
                                           String catalog)

Description copied from interface: ImportCDMFrComponent

Construct the query to retrieve the content.

Specified by:

getExpressionsList in interface ImportCDMFrComponent

Parameters:

lang - Lang

idValue - Synchronization value

contentType - Content type

catalog - The catalog

Returns:

The List of Expression

getLocalAndExternalFields

public Set<String> getLocalAndExternalFields(Map<String,Object> additionalParameters)

Description copied from interface: ImportCDMFrComponent

Get the path of tri-state fields (with local and external values)

Specified by:

getLocalAndExternalFields in interface ImportCDMFrComponent

Parameters:

additionalParameters - Additional parameters

Returns:

the synchronized fields