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

Class ImportTraversableProgramPartValuesExtractor

java.lang.Object

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

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

org.ametys.plugins.odfsync.cdmfr.extractor.ImportTraversableProgramPartValuesExtractor

All Implemented Interfaces:

ModelAwareValuesExtractor, ValuesExtractor

public class ImportTraversableProgramPartValuesExtractor
extends ImportCDMFrValuesExtractor

This class provides methods to extract traversable program part's values from a CMD-fr import document

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_synchronizationCode	The imported content's synchronization code
protected static final String	_TAG_CONTAINER	Tag to identify a container
protected static final String	_TAG_SUBPROGRAM	Tag to identify a subprogram

Fields inherited from class org.ametys.plugins.odfsync.cdmfr.extractor.ImportCDMFrValuesExtractor

_component, _context, _factory, _MULTIPLE_DATA_ITEM_TAG, _TAG_COURSELIST

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

_additionalDataGetter, _element, _modelItemContainers

Constructor Summary

Constructors

Constructor	Description
ImportTraversableProgramPartValuesExtractor(Element element, ImportCDMFrValuesExtractorFactory factory, ImportCDMFrComponent component, String synchronizationCode, ImportCDMFrContext context, XMLValuesExtractorAdditionalDataGetter additionalDataGetter, Collection<? extends ModelItemContainer> modelItemContainers)	Creates an import traversable program part values extractor
ImportTraversableProgramPartValuesExtractor(Element element, ImportCDMFrValuesExtractorFactory factory, ImportCDMFrComponent component, String synchronizationCode, ImportCDMFrContext context, XMLValuesExtractorAdditionalDataGetter additionalDataGetter, Model... models)	Creates an import traversable program part values extractor

Method Summary

Modifier and Type	Method	Description
protected <T> Object	_extractElementValue(Element parent, ElementDefinition<T> definition, Optional<Object> additionalData)	Extracts the value of the given element
protected Optional<ModelItem>	_getModelItemFromNodeName(Element parent, String nodeName, Collection<? extends ModelItemContainer> modelItemContainers)	Retrieves the model item corresponding to the given node name
protected boolean	_hasChildForAttribute(Element element, String attributeName)	Checks if the given element contains a child for the given attribute name

Methods inherited from class org.ametys.plugins.odfsync.cdmfr.extractor.ImportCDMFrValuesExtractor

_extractContentValue, _extractContentValues, _extractTableRefValue, _extractTableRefValues, _getAttributeOrDefault

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

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

Methods inherited from class java.lang.Object

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

Field Details

_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

_synchronizationCode

protected String _synchronizationCode

The imported content's synchronization code

Constructor Details

ImportTraversableProgramPartValuesExtractor

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

Creates an import traversable program part values extractor

Parameters:

element - the DOM element containing the XML values

factory - the values extractor factory

component - the import CDM-fr component

synchronizationCode - the imported content's synchronization code

context - the import context

additionalDataGetter - the getter that retrieves needed additional data by types

models - the model of the extracted values

ImportTraversableProgramPartValuesExtractor

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

Creates an import traversable program part values extractor

Parameters:

element - the DOM element containing the XML values

factory - the values extractor factory

component - the import CDM-fr component

synchronizationCode - the imported content's synchronization code

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

_getModelItemFromNodeName

protected Optional<ModelItem> _getModelItemFromNodeName(Element parent,
 String nodeName,
 Collection<? extends ModelItemContainer> modelItemContainers)

Description copied from class: ModelAwareXMLValuesExtractor

Retrieves the model item corresponding to the given node name

Overrides:

_getModelItemFromNodeName in class ModelAwareXMLValuesExtractor

Parameters:

parent - the DOM parent element

nodeName - the node name

modelItemContainers - the model item containers where to search for the model item

Returns:

the model item corresponding to the given node name

_hasChildForAttribute

protected boolean _hasChildForAttribute(Element element,
 String attributeName)

Description copied from class: ModelAwareXMLValuesExtractor

Checks if the given element contains a child for the given attribute name

Overrides:

_hasChildForAttribute in class ModelAwareXMLValuesExtractor

Parameters:

element - the element to check

attributeName - the name of the attribute to search

Returns:

true if the element contains a child corresponding to the given attribute name, false otherwise

_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 ImportCDMFrValuesExtractor

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