Package org.ametys.plugins.odfsync.cdmfr.extractor

Class ImportCDMFrValuesExtractor

java.lang.Object

org.ametys.plugins.repository.data.extractor.xml.ModelAwareXMLValuesExtractor

org.ametys.plugins.odfsync.cdmfr.extractor.ImportCDMFrValuesExtractor

All Implemented Interfaces:

ModelAwareValuesExtractor, ValuesExtractor

Direct Known Subclasses:

ImportCourseListValuesExtractor, ImportCoursePartValuesExtractor, ImportCourseValuesExtractor, ImportTraversableProgramPartValuesExtractor

public class ImportCDMFrValuesExtractor
extends ModelAwareXMLValuesExtractor

This class provides methods to extract values from a CMD-fr import document

Field Summary

Fields

Modifier and Type	Field	Description
protected ImportCDMFrComponent	_component	The import CDM-fr component
protected ImportCDMFrContext	_context	The import context
protected ImportCDMFrValuesExtractorFactory	_factory	The values extractor factory
protected static final String	_MULTIPLE_DATA_ITEM_TAG	Tag used for each value of multiples data
protected static final String	_TAG_COURSELIST	Tag to identify a courseList

Fields inherited from class org.ametys.plugins.repository.data.extractor.xml.ModelAwareXMLValuesExtractor

_additionalDataGetter, _element, _modelItemContainers

Constructor Summary

Constructors

Constructor	Description
ImportCDMFrValuesExtractor(Element element, ImportCDMFrValuesExtractorFactory factory, ImportCDMFrComponent component, ImportCDMFrContext context, XMLValuesExtractorAdditionalDataGetter additionalDataGetter, Collection<? extends ModelItemContainer> modelItemContainers)	Creates an import CDM-fr values extractor
ImportCDMFrValuesExtractor(Element element, ImportCDMFrValuesExtractorFactory factory, ImportCDMFrComponent component, ImportCDMFrContext context, XMLValuesExtractorAdditionalDataGetter additionalDataGetter, Model... models)	Creates an import CDM-fr values extractor

Method Summary

Modifier and Type	Method	Description
protected Optional<Content>	_extractContentValue(Element item, String contentTagName, ContentWorkflowDescription workflowDescription)	Extract the content value for the given attribute
protected Object	_extractContentValues(Element parent, ElementDefinition definition, String contentTagName, ContentWorkflowDescription workflowDescription)	Extract the content values for the given attribute
protected <T> Object	_extractElementValue(Element parent, ElementDefinition<T> definition, Optional<Object> additionalData)	Extracts the value of the given element
protected Optional<Content>	_extractTableRefValue(Element item, String contentTypeId)	Extract the content value for the given attribute
protected Object	_extractTableRefValues(Element parent, ElementDefinition definition, String contentTypeId)	Extract the table reference values for the given attribute
protected String	_getAttributeOrDefault(Element element, String attributeName, String defaultValue)	Retrieve the element's attribute with the given name, or the default value if there is no such attribute

Methods inherited from class org.ametys.plugins.repository.data.extractor.xml.ModelAwareXMLValuesExtractor

_extractElementValue, _extractGroupValues, _extractValue, _extractValue, _extractValues, _fillViewItemContainerFromXML, _fillViewItemContainerFromXML, _getModelItemFromNodeName, _hasChildForAttribute, extractValue, extractValues, extractValues

Methods inherited from class java.lang.Object

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

Field Details

_TAG_COURSELIST

protected static final String _TAG_COURSELIST

Tag to identify a courseList

See Also:

• Constant Field Values

_MULTIPLE_DATA_ITEM_TAG

protected static final String _MULTIPLE_DATA_ITEM_TAG

Tag used for each value of multiples data

See Also:

• Constant Field Values

_factory

protected ImportCDMFrValuesExtractorFactory _factory

The values extractor factory

_component

protected ImportCDMFrComponent _component

The import CDM-fr component

_context

protected ImportCDMFrContext _context

The import context

Constructor Details

ImportCDMFrValuesExtractor

public ImportCDMFrValuesExtractor(Element element,
 ImportCDMFrValuesExtractorFactory factory,
 ImportCDMFrComponent component,
 ImportCDMFrContext context,
 XMLValuesExtractorAdditionalDataGetter additionalDataGetter,
 Model... models)

Creates an import CDM-fr values extractor

Parameters:

element - the DOM element containing the XML values

factory - the values extractor factory

component - the import CDM-fr component

context - the import context

additionalDataGetter - the getter that retrieves needed additional data by types

models - the model of the extracted values

ImportCDMFrValuesExtractor

public ImportCDMFrValuesExtractor(Element element,
 ImportCDMFrValuesExtractorFactory factory,
 ImportCDMFrComponent component,
 ImportCDMFrContext context,
 XMLValuesExtractorAdditionalDataGetter additionalDataGetter,
 Collection<? extends ModelItemContainer> modelItemContainers)

Creates an import CDM-fr values extractor

Parameters:

element - the DOM element containing the XML values

factory - the values extractor factory

component - the import CDM-fr component

context - the imported content's context

additionalDataGetter - the getter that retrieves needed additional data by types

modelItemContainers - the model of the extracted values

Method Details

_extractElementValue

protected <T> Object _extractElementValue(Element parent,
 ElementDefinition<T> definition,
 Optional<Object> additionalData)
                                   throws Exception

Description copied from class: ModelAwareXMLValuesExtractor

Extracts the value of the given element

Overrides:

_extractElementValue in class ModelAwareXMLValuesExtractor

Type Parameters:

T - type of the element definition

Parameters:

parent - the DOM element of the element definition's parent

definition - the element's definition

additionalData - the additional data needed to extract the value

Returns:

the value

Throws:

Exception - if an error occurs

_extractContentValues

protected Object _extractContentValues(Element parent,
 ElementDefinition definition,
 String contentTagName,
 ContentWorkflowDescription workflowDescription)
                                throws Exception

Extract the content values for the given attribute

Parameters:

parent - the DOM element of the definition's parent

definition - the attribute's definition

contentTagName - the tag name of the contents to extract

workflowDescription - the ContentWorkflowDescription of the extracted contents

Returns:

the extracted contents

Throws:

Exception - if an error occurs

_extractContentValue

protected Optional<Content> _extractContentValue(Element item,
 String contentTagName,
 ContentWorkflowDescription workflowDescription)
                                          throws Exception

Extract the content value for the given attribute

Parameters:

item - the DOM element of the content item

contentTagName - the tag name of the contents to extract

workflowDescription - the ContentWorkflowDescription of the extracted contents

Returns:

the extracted content

Throws:

Exception - if an error occurs

_extractTableRefValues

protected Object _extractTableRefValues(Element parent,
 ElementDefinition definition,
 String contentTypeId)
                                 throws Exception

Extract the table reference values for the given attribute

Parameters:

parent - the DOM element of the definition's parent

definition - the attribute's definition

contentTypeId - the id of the content type

Returns:

the extracted contents

Throws:

Exception - if an error occurs

_extractTableRefValue

protected Optional<Content> _extractTableRefValue(Element item,
 String contentTypeId)
                                           throws Exception

Extract the content value for the given attribute

Parameters:

item - the DOM element of the content item

contentTypeId - the id of the content type

Returns:

the extracted content

Throws:

Exception - if an error occurs

_getAttributeOrDefault

protected String _getAttributeOrDefault(Element element,
 String attributeName,
 String defaultValue)

Retrieve the element's attribute with the given name, or the default value if there is no such attribute

Parameters:

element - the element

attributeName - the name of the attribute to retrieve

defaultValue - the default value

Returns:

the element's attribute