java.lang.Object
- org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection
- - org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection
  - - org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection
    - - org.ametys.plugins.odfsync.apogee.scc.AbstractApogeeSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, ApogeeSynchronizableContentsCollection, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

AbstractApogeeSynchronizableContentsWithCatalogCollection, OrgUnitSynchronizableContentsCollection
```
public abstract class AbstractApogeeSynchronizableContentsCollection
extends AbstractSimpleSynchronizableContentsCollection
implements Contextualizable, ApogeeSynchronizableContentsCollection
```
Abstract class for Apogee synchronization

Field Summary

Fields
Modifier and Type	Field	Description
`protected static String`	`__PARAM_COLUMNS`	Name of paramter holding columns
`protected static String`	`__PARAM_COLUMNS_COLUMN`	Name of paramter into columns holding column
`protected static String`	`__PARAM_CRITERIA`	Name of parameter holding the criteria
`protected static String`	`__PARAM_CRITERIA_CRITERION`	Name of parameter into criteria holding a criterion
`protected static String`	`__PARAM_CRITERIA_CRITERION_ID`	Name of parameter into criterion holding the id
`protected static String`	`__PARAM_CRITERIA_CRITERION_LABEL`	Name of parameter into criterion holding the label
`protected static String`	`__PARAM_CRITERIA_CRITERION_TYPE`	Name of parameter into criterion holding the type
`protected static String`	`__PARAM_ID_COLUMN`	Name of parameter holding the field ID column
`protected static String`	`__PARAM_MAPPING`	Name of parameter holding the fields mapping
`protected static String`	`__PARAM_MAPPING_ATTRIBUTE`	Name of parameter into mapping holding the remote attribute
`protected static String`	`__PARAM_MAPPING_METADATA_REF`	Name of parameter into mapping holding the path of metadata
`protected static String`	`__PARAM_MAPPING_SYNCHRO`	Name of parameter into mapping holding the synchronized property
`protected ApogeeDAO`	`_apogeeDAO`	The DAO for remote DB Apogee
`protected ApogeeSynchronizableContentsCollectionHelper`	`_apogeeSCCHelper`	The Apogee SCC helper
`protected Set<String>`	`_columns`	Synchronized fields
`protected Context`	`_context`	Context
`protected Set<ApogeeCriterion>`	`_criteria`	Synchronized fields
`protected Set<String>`	`_extFields`	External fields
`protected String`	`_idColumn`	Name of the Apogée column which contains the ID
`protected JSONUtils`	`_jsonUtils`	The JSON utils
`protected Map<String,List<String>>`	`_mapping`	Mapping between metadata and columns
`protected ODFHelper`	`_odfHelper`	The ODF helper
`protected String`	`_odfLang`	Default language configured for ODF
`protected SynchronizableContentsCollectionDAO`	`_sccDAO`	SCC DAO
`protected Set<String>`	`_syncFields`	Synchronized fields
`static String`	`PARAM_ADD_UNEXISTING_CHILDREN`	Name of parameter holding the adding unexisting children parameter
`static String`	`PARAM_DATASOURCE_ID`	Name of parameter holding the data source id
`static String`	`PARAM_YEAR`	Name of parameter holding the administrative year

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection
_contentHelper, _synchronizingContentOperatorEP

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection
_contentTypeEP, _currentUserProvider, _hasGlobalError, _i18nUtils, _nbCreatedContents, _nbDeletedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, _synchroComponent, SCC_UNIQUE_ID

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection
_contentDAO, _contentPrefix, _contentType, _id, _initialActionId, _label, _languages, _modelId, _modelParamValues, _removalSync, _reportMails, _resolver, _restrictedField, _sccHelper, _searchModelConfiguration, _synchronizeActionId, _synchronizeExistingContentsOnly, _synchronizingContentOperator, _validateActionId, _validateAfterImport, _workflowName

Fields inherited from interface org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollection
COLLECTION_ID_PROPERTY

Constructor Summary

Constructors
Constructor Description

AbstractApogeeSynchronizableContentsCollection()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected List<ModifiableContent>`	`_addUnexistingChildren(SynchronizableContentsCollection scc, Set<String> childrenRemoteSyncCode, org.slf4j.Logger logger)`	Add unexisting children in Ametys from Apogee
`protected Object`	`_convertBigDecimal(String contentTypeId, String attributeName, Object objectToConvert)`	Convert the object in parameter to a long if it's a `BigDecimal`, otherwise return the object itself.
`protected List<Map<String,Object>>`	`_convertBigDecimal(List<Map<String,Object>> searchResults)`	Convert the `BigDecimal` values retrieved from database into long values
`protected boolean`	`_fillContent(Map<String,List<Object>> remoteValues, ModifiableDefaultContent content, boolean create, org.slf4j.Logger logger)`	Fill the content with remote values.
`protected boolean`	`_fillRichTexts(Map<String,List<Object>> remoteValues, ModifiableDefaultContent content, boolean create, org.slf4j.Logger logger)`	Fill the richt texts of the content with the remote values.
`protected Set<String>`	`_getChildrenRemoteSyncCode(ModifiableDefaultContent content, SynchronizableContentsCollection scc, org.slf4j.Logger logger)`	Get the remote sync codes
`private I18nizableText`	`_getCriterionLabel(Configuration configuration, String defaultValue)`
`protected String`	`_getSort(List<Object> sortList)`	Transform the given `List` of `Object` to a `String` representing the ordered fields for SQL.
`protected boolean`	`_handleAdditionalMetadata(ModifiableCompositeMetadata holder, boolean create)`	Method to add additional metadata on import or synchronize.
`protected boolean`	`_importChildren(ModifiableDefaultContent content, SynchronizableContentsCollection scc, String metadataName, String invertMetadataName, org.slf4j.Logger logger)`	Import children
`protected ModifiableDefaultContent`	`_importContent(String idValue, Map<String,Object> importParams, String lang, Map<String,List<Object>> remoteValues, org.slf4j.Logger logger)`	Import a content from remote values.
`protected List<ModifiableDefaultContent>`	`_importOrSynchronizeContent(String idValue, Map<String,List<Object>> remoteValues, boolean forceImport, org.slf4j.Logger logger)`	Imports or synchronizes a content for each available language
`protected Stream<ModifiableDefaultContent>`	`_importUnexistingChildren(SynchronizableContentsCollection scc, String syncCode, Map<String,List<Object>> params, org.slf4j.Logger logger)`	Import an unexisting child in Ametys
`protected List<ModifiableDefaultContent>`	`_internalPopulate(org.slf4j.Logger logger)`	Internal implementation of `AbstractSynchronizableContentsCollection.populate(Logger)`
`protected boolean`	`_isChildWillBeRemoved(ModifiableContent content, SynchronizableContentsCollection scc, Set<String> childrenRemoteSyncCode, org.slf4j.Logger logger)`	True if the content will be removed from the structure
`protected boolean`	`_resetChildren(ModifiableDefaultContent content, List<? extends ModifiableContent> importedOrSynchronizedChildren, String metadataName, String invertMetadataName, org.slf4j.Logger logger)`	Reset the children of the structure to force with the children from Apogée.
`protected abstract List<Map<String,Object>>`	`_search(Map<String,Object> searchParams, org.slf4j.Logger logger)`	Search the contents with the search parameters.
`protected void`	`_setRichTextValue(ModifiableRichText richText, List<Object> remoteValue)`	Set the value on the rich text.
`protected boolean`	`_synchronizeChildren(ModifiableDefaultContent content, SynchronizableContentsCollection scc, String metadataName, String invertMetadataName, org.slf4j.Logger logger)`	Synchronize children
`protected ModifiableDefaultContent`	`_synchronizeContent(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, org.slf4j.Logger logger)`	Synchronize a content with remove values.
`protected Object`	`_transformClobToString(Object value, String idValue, org.slf4j.Logger logger)`	Transform CLOB value to String value.
`protected Map<String,List<Object>>`	`_transformListOfMap2MapOfList(List<Map<String,Object>> lines)`	Transform a `List` of `Map` to a `Map` of `List` computed by keys (lines to columns).
`private Map<String,List<Object>>`	`_transformOrgUnitMetadata(Map<String,List<Object>> remoteValues, org.slf4j.Logger logger)`
`protected boolean`	`additionalCommonOperations(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Map<String,Object> importParams, boolean create, org.slf4j.Logger logger)`	Add specific fields to the content during import or synchronization.
`protected boolean`	`addUnexistingChildren()`	Check if unexisting contents in Ametys should be added from data source
`protected void`	`configureDataSource(Configuration configuration)`	Configure the data source parameters.
`protected void`	`configureSearchModel()`	Configure the search model used by SCCSearchTool.
`void`	`contextualize(Context context)`
`protected abstract String`	`getChildrenInvertMetadataName()`	Get the metadata name to get parent from children
`protected abstract String`	`getChildrenMetadataName()`	Get the metadata name to get children
`protected String`	`getChildrenSCCModelId()`	Get the children SCC model id.
`protected Set<String>`	`getClobColumns()`	Get the list of CLOB column's names.
`protected String`	`getDataSourceId()`	Get the id of data source
`Set<String>`	`getExternalOnlyFields(Map<String,Object> additionalParameters)`	Get the path of field that are valued externally only.
`protected String`	`getIdColumn()`	Get the identifier column (can be a concatened column).
`String`	`getIdField()`	Get the path of metadata holding the unique identifier
`Set<String>`	`getLocalAndExternalFields(Map<String,Object> additionalParameters)`	Get the path of tri-state fields (with local and external values)
`protected abstract String`	`getMappingName()`	Get the name of the mapping.
`protected Map<String,Map<String,List<Object>>>`	`getRemoteValues(Map<String,Object> parameters, org.slf4j.Logger logger)`	Search values and return the result organized by metadata
`protected Set<String>`	`getRichTextFields()`	Get the list of rich text fields of the imported content.
`int`	`getTotalCount(Map<String,Object> parameters, org.slf4j.Logger logger)`	Return the total number of results for the search.
`protected String`	`getYear()`	Get the administrative year
`protected boolean`	`handleChildren(ModifiableDefaultContent content, boolean create, org.slf4j.Logger logger)`	Set the children metadata and invert relation, import and synchronize the children too.
`protected boolean`	`handleParent(ModifiableDefaultContent currentContent, ModifiableDefaultContent parentContent, org.slf4j.Logger logger)`	Set the parent metadata and invert relation.
`boolean`	`handleRightAssignmentContext()`	Return true if a `RightAssignmentContext` should be automatically generated for the contents of this SCC
`List<ModifiableDefaultContent>`	`importContent(String idValue, Map<String,Object> importParams, org.slf4j.Logger logger)`	Import a content from remote values.
`protected boolean`	`importOrSynchronizeChildren(ModifiableDefaultContent content, String sccModelId, String metadataName, String invertMetadataName, boolean create, org.slf4j.Logger logger)`	Import and synchronize children of the given content, then edit the structure of the content and its children.
`List<ModifiableDefaultContent>`	`importOrSynchronizeContents(Map<String,Object> searchParams, org.slf4j.Logger logger)`	Method used to import the structure of an ODF content or its dependencies, import or synchronize each child recursively.
`protected Map<String,Map<String,Object>>`	`internalSearch(Map<String,Object> parameters, int offset, int limit, List<Object> sort, org.slf4j.Logger logger)`	Search values and return the result without any treatment.
`List<ModifiableDefaultContent>`	`populate(org.slf4j.Logger logger)`	Populates contents
`protected Map<String,Object>`	`putIdParameter(String idValue)`	Set search parameters for the ID value.
`void`	`service(ServiceManager manager)`
`protected boolean`	`setAdditionalMetadata(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, boolean create, org.slf4j.Logger logger)`	Set the additional metadata.
`void`	`synchronizeContent(ModifiableDefaultContent content, org.slf4j.Logger logger)`	Synchronize a content with remove values.

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection
_getContentsToRemove, _getIdFieldValue, _handleContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _isHandled, additionalImportOperations, additionalSynchronizeOperations, configure, createContentAction, getContent, getTransformedRemoteValues, search, updateSyncInformations, validateContent

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection
_deleteContents, _getContentPathQuery, _getExpressionsList, _getMetadataHolder, _isParamNotEmpty, _removeEmptyParameters, _removeMetadataIfExists, _synchronizeMetadata, _updateRelation, _updateRelation, applyChanges, applyChanges, createContentAction, deleteUnexistingContents, empty, sendErrorMail, updateSCCProperty, validateContent

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection
_parseLanguages, _parseParameters, configureStaticParams, getContentPrefix, getContentType, getId, getInitialActionId, getLabel, getLanguages, getParameterValues, getReportMails, getRestrictedField, getSearchModelConfiguration, getSynchronizeActionId, getSynchronizeCollectionModelId, getSynchronizingContentOperator, getValidateActionId, getWorkflowName, removalSync, synchronizeExistingContentsOnly, validateAfterImport

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAM_DATASOURCE_ID
```
public static final String PARAM_DATASOURCE_ID
```
    Name of parameter holding the data source id
    
    See Also:
    
    Constant Field Values
  - PARAM_YEAR
```
public static final String PARAM_YEAR
```
    Name of parameter holding the administrative year
    
    See Also:
    
    Constant Field Values
  - PARAM_ADD_UNEXISTING_CHILDREN
```
public static final String PARAM_ADD_UNEXISTING_CHILDREN
```
    Name of parameter holding the adding unexisting children parameter
    
    See Also:
    
    Constant Field Values
  - __PARAM_ID_COLUMN
```
protected static final String __PARAM_ID_COLUMN
```
    Name of parameter holding the field ID column
    
    See Also:
    
    Constant Field Values
  - __PARAM_MAPPING
```
protected static final String __PARAM_MAPPING
```
    Name of parameter holding the fields mapping
    
    See Also:
    
    Constant Field Values
  - __PARAM_MAPPING_SYNCHRO
```
protected static final String __PARAM_MAPPING_SYNCHRO
```
    Name of parameter into mapping holding the synchronized property
    
    See Also:
    
    Constant Field Values
  - __PARAM_MAPPING_METADATA_REF
```
protected static final String __PARAM_MAPPING_METADATA_REF
```
    Name of parameter into mapping holding the path of metadata
    
    See Also:
    
    Constant Field Values
  - __PARAM_MAPPING_ATTRIBUTE
```
protected static final String __PARAM_MAPPING_ATTRIBUTE
```
    Name of parameter into mapping holding the remote attribute
    
    See Also:
    
    Constant Field Values
  - __PARAM_CRITERIA
```
protected static final String __PARAM_CRITERIA
```
    Name of parameter holding the criteria
    
    See Also:
    
    Constant Field Values
  - __PARAM_CRITERIA_CRITERION
```
protected static final String __PARAM_CRITERIA_CRITERION
```
    Name of parameter into criteria holding a criterion
    
    See Also:
    
    Constant Field Values
  - __PARAM_CRITERIA_CRITERION_ID
```
protected static final String __PARAM_CRITERIA_CRITERION_ID
```
    Name of parameter into criterion holding the id
    
    See Also:
    
    Constant Field Values
  - __PARAM_CRITERIA_CRITERION_LABEL
```
protected static final String __PARAM_CRITERIA_CRITERION_LABEL
```
    Name of parameter into criterion holding the label
    
    See Also:
    
    Constant Field Values
  - __PARAM_CRITERIA_CRITERION_TYPE
```
protected static final String __PARAM_CRITERIA_CRITERION_TYPE
```
    Name of parameter into criterion holding the type
    
    See Also:
    
    Constant Field Values
  - __PARAM_COLUMNS
```
protected static final String __PARAM_COLUMNS
```
    Name of paramter holding columns
    
    See Also:
    
    Constant Field Values
  - __PARAM_COLUMNS_COLUMN
```
protected static final String __PARAM_COLUMNS_COLUMN
```
    Name of paramter into columns holding column
    
    See Also:
    
    Constant Field Values
  - _odfLang
```
protected String _odfLang
```
    Default language configured for ODF
  - _idColumn
```
protected String _idColumn
```
    Name of the Apogée column which contains the ID
  - _mapping
```
protected Map<String,List<String>> _mapping
```
    Mapping between metadata and columns
  - _extFields
```
protected Set<String> _extFields
```
    External fields
  - _syncFields
```
protected Set<String> _syncFields
```
    Synchronized fields
  - _columns
```
protected Set<String> _columns
```
    Synchronized fields
  - _criteria
```
protected Set<ApogeeCriterion> _criteria
```
    Synchronized fields
  - _context
```
protected Context _context
```
    Context
  - _apogeeDAO
```
protected ApogeeDAO _apogeeDAO
```
    The DAO for remote DB Apogee
  - _jsonUtils
```
protected JSONUtils _jsonUtils
```
    The JSON utils
  - _sccDAO
```
protected SynchronizableContentsCollectionDAO _sccDAO
```
    SCC DAO
  - _odfHelper
```
protected ODFHelper _odfHelper
```
    The ODF helper
  - _apogeeSCCHelper
```
protected ApogeeSynchronizableContentsCollectionHelper _apogeeSCCHelper
```
    The Apogee SCC helper
- Constructor Detail
  - AbstractApogeeSynchronizableContentsCollection
```
public AbstractApogeeSynchronizableContentsCollection()
```
- Method Detail
  - service
```
public void service(ServiceManager manager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Overrides:
    
    service in class AbstractSimpleSynchronizableContentsCollection
    
    Throws:
    
    ServiceException
  - contextualize
```
public void contextualize(Context context)
                   throws ContextException
```
    Specified by:
    
    contextualize in interface Contextualizable
    
    Throws:
    
    ContextException
  - configureDataSource
```
protected void configureDataSource(Configuration configuration)
                            throws ConfigurationException
```
    Description copied from class: AbstractStaticSynchronizableContentsCollection
    
    Configure the data source parameters.
    
    Specified by:
    
    configureDataSource in class AbstractStaticSynchronizableContentsCollection
    
    Parameters:
    
    configuration - Configuration to read
    
    Throws:
    
    ConfigurationException - If an error occurs
  - _getCriterionLabel
```
private I18nizableText _getCriterionLabel(Configuration configuration,
                                          String defaultValue)
```
  - populate
```
public List<ModifiableDefaultContent> populate(org.slf4j.Logger logger)
```
    Description copied from interface: SynchronizableContentsCollection
    
    Populates contents
    
    Specified by:
    
    populate in interface SynchronizableContentsCollection
    
    Overrides:
    
    populate in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    logger - The logger
    
    Returns:
    
    Return the populated contents (imported or synchronized)
  - _internalPopulate
```
protected List<ModifiableDefaultContent> _internalPopulate(org.slf4j.Logger logger)
```
    Description copied from class: AbstractSynchronizableContentsCollection
    
    Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)
    
    Overrides:
    
    _internalPopulate in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    logger - The logger
    
    Returns:
    
    The list of created/synchronized contents
  - internalSearch
```
protected Map<String,Map<String,Object>> internalSearch(Map<String,Object> parameters,
                                                                    int offset,
                                                                    int limit,
                                                                    List<Object> sort,
                                                                    org.slf4j.Logger logger)
```
    Description copied from class: AbstractSimpleSynchronizableContentsCollection
    
    Search values and return the result without any treatment.
    
    Specified by:
    
    internalSearch in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    parameters - Search parameters to restrict the search
    
    offset - Begin of the search
    
    limit - Number of results
    
    sort - Sort of results (ignored for LDAP results)
    
    logger - The logger
    
    Returns:
    
    Map of results without any treatment.
  - getRemoteValues
```
protected Map<String,Map<String,List<Object>>> getRemoteValues(Map<String,Object> parameters,
                                                                           org.slf4j.Logger logger)
```
    Description copied from class: AbstractSimpleSynchronizableContentsCollection
    
    Search values and return the result organized by metadata
    
    Specified by:
    
    getRemoteValues in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    parameters - Search parameters to restrict the search
    
    logger - The logger
    
    Returns:
    
    Map of results organized by metadata.
  - _importOrSynchronizeContent
```
protected List<ModifiableDefaultContent> _importOrSynchronizeContent(String idValue,
                                                                     Map<String,List<Object>> remoteValues,
                                                                     boolean forceImport,
                                                                     org.slf4j.Logger logger)
```
    Description copied from class: AbstractSimpleSynchronizableContentsCollection
    
    Imports or synchronizes a content for each available language
    
    Overrides:
    
    _importOrSynchronizeContent in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    idValue - The unique identifier of the content
    
    remoteValues - The remote values
    
    forceImport - To force import and ignoring the synchronize existing contents only option
    
    logger - The logger
    
    Returns:
    
    The list of synchronized or imported contents
  - importContent
```
public List<ModifiableDefaultContent> importContent(String idValue,
                                                    Map<String,Object> importParams,
                                                    org.slf4j.Logger logger)
                                             throws Exception
```
    Description copied from interface: SynchronizableContentsCollection
    
    Import a content from remote values.
    
    Specified by:
    
    importContent in interface SynchronizableContentsCollection
    
    Overrides:
    
    importContent in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    idValue - Id (for import/synchronization) of the content to import
    
    importParams - Additional parameters
    
    logger - The logger
    
    Returns:
    
    A list of created contents
    
    Throws:
    
    Exception - if an error occurs.
  - synchronizeContent
```
public void synchronizeContent(ModifiableDefaultContent content,
                               org.slf4j.Logger logger)
                        throws Exception
```
    Description copied from interface: SynchronizableContentsCollection
    
    Synchronize a content with remove values.
    
    Specified by:
    
    synchronizeContent in interface SynchronizableContentsCollection
    
    Overrides:
    
    synchronizeContent in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    content - The content to synchronize
    
    logger - The logger
    
    Throws:
    
    Exception - if an error occurs.
  - putIdParameter
```
protected Map<String,Object> putIdParameter(String idValue)
```
    Description copied from class: AbstractSimpleSynchronizableContentsCollection
    
    Set search parameters for the ID value.
    
    Specified by:
    
    putIdParameter in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    idValue - Value to search
    
    Returns:
    
    Map with the search parameters
  - _search
```
protected abstract List<Map<String,Object>> _search(Map<String,Object> searchParams,
                                                          org.slf4j.Logger logger)
```
    Search the contents with the search parameters. Use id parameter to search an unique content.
    
    Parameters:
    
    searchParams - Search parameters
    
    logger - The logger
    
    Returns:
    
    A Map of mapped metadatas extract from Apogée database ordered by content unique Apogée ID
  - _convertBigDecimal
```
protected List<Map<String,Object>> _convertBigDecimal(List<Map<String,Object>> searchResults)
```
    Convert the BigDecimal values retrieved from database into long values
    
    Parameters:
    
    searchResults - The initial search results from database
    
    Returns:
    
    The converted search results
  - _convertBigDecimal
```
protected Object _convertBigDecimal(String contentTypeId,
                                    String attributeName,
                                    Object objectToConvert)
```
    Convert the object in parameter to a long if it's a BigDecimal, otherwise return the object itself.
    
    Parameters:
    
    contentTypeId - The content type of the parent content
    
    attributeName - The metadata name
    
    objectToConvert - The object to convert if necessary
    
    Returns:
    
    The converted object
  - _transformClobToString
```
protected Object _transformClobToString(Object value,
                                        String idValue,
                                        org.slf4j.Logger logger)
```
    Transform CLOB value to String value.
    
    Parameters:
    
    value - The input value
    
    idValue - The identifier of the program
    
    logger - The logger
    
    Returns:
    
    the same value, with CLOB transformed to String.
  - getClobColumns
```
protected Set<String> getClobColumns()
```
    Get the list of CLOB column's names.
    
    Returns:
    
    The list of the CLOB column's names to transform to String
  - _transformListOfMap2MapOfList
```
protected Map<String,List<Object>> _transformListOfMap2MapOfList(List<Map<String,Object>> lines)
```
    Transform a List of Map to a Map of List computed by keys (lines to columns).
    
    Parameters:
    
    lines - List to reorganize
    
    Returns:
    
    Map of List
  - getMappingName
```
protected abstract String getMappingName()
```
    Get the name of the mapping.
    
    Returns:
    
    the mapping name
  - getDataSourceId
```
protected String getDataSourceId()
```
    Get the id of data source
    
    Returns:
    
    The id of data source
  - getYear
```
protected String getYear()
```
    Get the administrative year
    
    Returns:
    
    The administrative year
  - addUnexistingChildren
```
protected boolean addUnexistingChildren()
```
    Check if unexisting contents in Ametys should be added from data source
    
    Returns:
    
    true if unexisting contents in Ametys should be added from data source, default value is false
  - getIdColumn
```
protected String getIdColumn()
```
    Get the identifier column (can be a concatened column).
    
    Returns:
    
    the column id
  - getIdField
```
public String getIdField()
```
    Description copied from interface: SynchronizableContentsCollection
    
    Get the path of metadata holding the unique identifier
    
    Specified by:
    
    getIdField in interface SynchronizableContentsCollection
    
    Returns:
    
    the path to the metadata. Can be null.
  - getLocalAndExternalFields
```
public Set<String> getLocalAndExternalFields(Map<String,Object> additionalParameters)
```
    Description copied from interface: SynchronizableContentsCollection
    
    Get the path of tri-state fields (with local and external values)
    
    Specified by:
    
    getLocalAndExternalFields in interface SynchronizableContentsCollection
    
    Parameters:
    
    additionalParameters - Additional parameters
    
    Returns:
    
    the synchronized fields
  - getExternalOnlyFields
```
public Set<String> getExternalOnlyFields(Map<String,Object> additionalParameters)
```
    Description copied from interface: SynchronizableContentsCollection
    
    Get the path of field that are valued externally only.
    
    Specified by:
    
    getExternalOnlyFields in interface SynchronizableContentsCollection
    
    Parameters:
    
    additionalParameters - Additional parameters
    
    Returns:
    
    the external fields
  - _fillContent
```
protected boolean _fillContent(Map<String,List<Object>> remoteValues,
                               ModifiableDefaultContent content,
                               boolean create,
                               org.slf4j.Logger logger)
```
    Description copied from class: AbstractSimpleSynchronizableContentsCollection
    
    Fill the content with remote values.
    
    Overrides:
    
    _fillContent in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    remoteValues - The remote values
    
    content - The content to synchronize
    
    create - true if content is creating, false if it is updated
    
    logger - The logger
    
    Returns:
    
    true if changes were made
  - _fillRichTexts
```
protected boolean _fillRichTexts(Map<String,List<Object>> remoteValues,
                                 ModifiableDefaultContent content,
                                 boolean create,
                                 org.slf4j.Logger logger)
```
    Fill the richt texts of the content with the remote values.
    
    Parameters:
    
    remoteValues - The remote values
    
    content - The content to synchronize
    
    create - true if content is creating, false if it is updated
    
    logger - The logger
    
    Returns:
    
    true if changes were made
  - _setRichTextValue
```
protected void _setRichTextValue(ModifiableRichText richText,
                                 List<Object> remoteValue)
                          throws IOException
```
    Set the value on the rich text.
    
    Parameters:
    
    richText - The rich text to update
    
    remoteValue - The remote value of the rich text (can be composed of several texts to concatenate)
    
    Throws:
    
    IOException - if an exception occurs
  - _handleAdditionalMetadata
```
protected boolean _handleAdditionalMetadata(ModifiableCompositeMetadata holder,
                                            boolean create)
```
    Method to add additional metadata on import or synchronize.
    
    Parameters:
    
    holder - The holder of the content to update
    
    create - If we are on creation mode
    
    Returns:
    
    true if changes has been made
  - getRichTextFields
```
protected Set<String> getRichTextFields()
```
    Get the list of rich text fields of the imported content.
    
    Returns:
    
    The list of the rich text fields metadata name
  - configureSearchModel
```
protected void configureSearchModel()
```
    Description copied from class: AbstractStaticSynchronizableContentsCollection
    
    Configure the search model used by SCCSearchTool.
    
    Specified by:
    
    configureSearchModel in class AbstractStaticSynchronizableContentsCollection
  - additionalCommonOperations
```
protected boolean additionalCommonOperations(ModifiableDefaultContent content,
                                             Map<String,List<Object>> remoteValues,
                                             Map<String,Object> importParams,
                                             boolean create,
                                             org.slf4j.Logger logger)
```
    Description copied from class: AbstractSimpleSynchronizableContentsCollection
    
    Add specific fields to the content during import or synchronization.
    
    Overrides:
    
    additionalCommonOperations in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    content - Content to update
    
    remoteValues - Values of the content
    
    importParams - the import params
    
    create - true if the content has been newly created
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - handleParent
```
protected boolean handleParent(ModifiableDefaultContent currentContent,
                               ModifiableDefaultContent parentContent,
                               org.slf4j.Logger logger)
```
    Set the parent metadata and invert relation.
    
    Parameters:
    
    currentContent - Current content
    
    parentContent - Parent content to set
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - handleChildren
```
protected boolean handleChildren(ModifiableDefaultContent content,
                                 boolean create,
                                 org.slf4j.Logger logger)
```
    Set the children metadata and invert relation, import and synchronize the children too.
    
    Parameters:
    
    content - Current content
    
    create - true if the content has been newly created
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - getChildrenSCCModelId
```
protected String getChildrenSCCModelId()
```
    Get the children SCC model id. Can be null if no implementation is defined.
    
    Returns:
    
    the children SCC model id
  - getChildrenMetadataName
```
protected abstract String getChildrenMetadataName()
```
    Get the metadata name to get children
    
    Returns:
    
    the metadata name to get children
  - getChildrenInvertMetadataName
```
protected abstract String getChildrenInvertMetadataName()
```
    Get the metadata name to get parent from children
    
    Returns:
    
    the metadata name to get parent from children
  - setAdditionalMetadata
```
protected boolean setAdditionalMetadata(ModifiableDefaultContent content,
                                        Map<String,List<Object>> remoteValues,
                                        boolean create,
                                        org.slf4j.Logger logger)
```
    Set the additional metadata.
    
    Parameters:
    
    content - Current content
    
    remoteValues - Values of the content
    
    create - true if the content has been newly created
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - _getSort
```
protected String _getSort(List<Object> sortList)
```
    Transform the given List of Object to a String representing the ordered fields for SQL.
    
    Parameters:
    
    sortList - The sort list object to transform to the list of ordered fields compatible with SQL.
    
    Returns:
    
    A string representing the list of ordered fields
  - getTotalCount
```
public int getTotalCount(Map<String,Object> parameters,
                         org.slf4j.Logger logger)
```
    Description copied from interface: SynchronizableContentsCollection
    
    Return the total number of results for the search.
    
    Specified by:
    
    getTotalCount in interface SynchronizableContentsCollection
    
    Overrides:
    
    getTotalCount in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    parameters - Parameters for the search
    
    logger - The logger
    
    Returns:
    
    The total count
  - _importContent
```
protected ModifiableDefaultContent _importContent(String idValue,
                                                  Map<String,Object> importParams,
                                                  String lang,
                                                  Map<String,List<Object>> remoteValues,
                                                  org.slf4j.Logger logger)
                                           throws Exception
```
    Description copied from class: AbstractSimpleSynchronizableContentsCollection
    
    Import a content from remote values.
    
    Overrides:
    
    _importContent in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    idValue - Id (for import/synchronization) of the content to import
    
    importParams - Specific parameters for import
    
    lang - Lang of the content
    
    remoteValues - Values of the content
    
    logger - The logger
    
    Returns:
    
    The content created by import, or null
    
    Throws:
    
    Exception - if an error occurs.
  - _synchronizeContent
```
protected ModifiableDefaultContent _synchronizeContent(ModifiableDefaultContent content,
                                                       Map<String,List<Object>> remoteValues,
                                                       org.slf4j.Logger logger)
                                                throws Exception
```
    Description copied from class: AbstractSimpleSynchronizableContentsCollection
    
    Synchronize a content with remove values.
    
    Overrides:
    
    _synchronizeContent in class AbstractSimpleSynchronizableContentsCollection
    
    Parameters:
    
    content - The content to synchronize
    
    remoteValues - Values to synchronize
    
    logger - The logger
    
    Returns:
    
    The synchronized content
    
    Throws:
    
    Exception - if an error occurs.
  - importOrSynchronizeChildren
```
protected boolean importOrSynchronizeChildren(ModifiableDefaultContent content,
                                              String sccModelId,
                                              String metadataName,
                                              String invertMetadataName,
                                              boolean create,
                                              org.slf4j.Logger logger)
```
    Import and synchronize children of the given content, then edit the structure of the content and its children. In the usual case, if we are in import mode (create to true) or if we trust the source (removalSync to true) we just synchronize structure but we don't synchronize child contents
    
    Parameters:
    
    content - Parent content
    
    sccModelId - SCC model ID
    
    metadataName - Metadata name to set
    
    invertMetadataName - Metadata name of the invert relation
    
    create - true if the content has been newly created
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - _importChildren
```
protected boolean _importChildren(ModifiableDefaultContent content,
                                  SynchronizableContentsCollection scc,
                                  String metadataName,
                                  String invertMetadataName,
                                  org.slf4j.Logger logger)
```
    Import children
    
    Parameters:
    
    content - Parent content
    
    scc - the scc
    
    metadataName - Metadata name to set
    
    invertMetadataName - Metadata name of the invert relation
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - _synchronizeChildren
```
protected boolean _synchronizeChildren(ModifiableDefaultContent content,
                                       SynchronizableContentsCollection scc,
                                       String metadataName,
                                       String invertMetadataName,
                                       org.slf4j.Logger logger)
```
    Synchronize children
    
    Parameters:
    
    content - Parent content
    
    scc - the scc
    
    metadataName - Metadata name to set
    
    invertMetadataName - Metadata name of the invert relation
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - _getChildrenRemoteSyncCode
```
protected Set<String> _getChildrenRemoteSyncCode(ModifiableDefaultContent content,
                                                 SynchronizableContentsCollection scc,
                                                 org.slf4j.Logger logger)
```
    Get the remote sync codes
    
    Parameters:
    
    content - Parent content
    
    scc - the scc
    
    logger - The logger
    
    Returns:
    
    the remote sync codes or null if the scc is not from Apogee
  - _addUnexistingChildren
```
protected List<ModifiableContent> _addUnexistingChildren(SynchronizableContentsCollection scc,
                                                         Set<String> childrenRemoteSyncCode,
                                                         org.slf4j.Logger logger)
```
    Add unexisting children in Ametys from Apogee
    
    Parameters:
    
    scc - the scc to import contents
    
    childrenRemoteSyncCode - the remote sync codes
    
    logger - the logger
    
    Returns:
    
    the list of unexisting contents
  - _importUnexistingChildren
```
protected Stream<ModifiableDefaultContent> _importUnexistingChildren(SynchronizableContentsCollection scc,
                                                                     String syncCode,
                                                                     Map<String,List<Object>> params,
                                                                     org.slf4j.Logger logger)
```
    Import an unexisting child in Ametys
    
    Parameters:
    
    scc - the scc to import the content
    
    syncCode - the sync code of the content
    
    params - the additional params
    
    logger - the logger
    
    Returns:
    
    the list of created children
  - _isChildWillBeRemoved
```
protected boolean _isChildWillBeRemoved(ModifiableContent content,
                                        SynchronizableContentsCollection scc,
                                        Set<String> childrenRemoteSyncCode,
                                        org.slf4j.Logger logger)
```
    True if the content will be removed from the structure
    
    Parameters:
    
    content - the content
    
    scc - the scc
    
    childrenRemoteSyncCode - the remote sync codes
    
    logger - the logger
    
    Returns:
    
    true if the content will be removed from the structure
  - _resetChildren
```
protected boolean _resetChildren(ModifiableDefaultContent content,
                                 List<? extends ModifiableContent> importedOrSynchronizedChildren,
                                 String metadataName,
                                 String invertMetadataName,
                                 org.slf4j.Logger logger)
```
    Reset the children of the structure to force with the children from Apogée.
    
    Parameters:
    
    content - Parent content
    
    importedOrSynchronizedChildren - the imported or synchronized children
    
    metadataName - Metadata name to set
    
    invertMetadataName - Metadata name of the invert relation
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - importOrSynchronizeContents
```
public List<ModifiableDefaultContent> importOrSynchronizeContents(Map<String,Object> searchParams,
                                                                  org.slf4j.Logger logger)
```
    Description copied from interface: ApogeeSynchronizableContentsCollection
    
    Method used to import the structure of an ODF content or its dependencies, import or synchronize each child recursively.
    
    Specified by:
    
    importOrSynchronizeContents in interface ApogeeSynchronizableContentsCollection
    
    Parameters:
    
    searchParams - Search parameters
    
    logger - The logger
    
    Returns:
    
    The List of ModifiableDefaultContent of children (imported or synchronized)
  - _transformOrgUnitMetadata
```
private Map<String,List<Object>> _transformOrgUnitMetadata(Map<String,List<Object>> remoteValues,
                                                                 org.slf4j.Logger logger)
```
  - handleRightAssignmentContext
```
public boolean handleRightAssignmentContext()
```
    Description copied from interface: SynchronizableContentsCollection
    
    Return true if a RightAssignmentContext should be automatically generated for the contents of this SCC
    
    Specified by:
    
    handleRightAssignmentContext in interface SynchronizableContentsCollection
    
    Returns:
    
    true to automatically generate a RightAssignmentContext. Return false if the rights of contents of this SCC are handle by its own RightAssignmentContext

Class AbstractApogeeSynchronizableContentsCollection

Field Summary

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

Fields inherited from interface org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollection

Constructor Summary

Method Summary

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

Methods inherited from class java.lang.Object

Field Detail

PARAM_DATASOURCE_ID

PARAM_YEAR

PARAM_ADD_UNEXISTING_CHILDREN

__PARAM_ID_COLUMN

__PARAM_MAPPING

__PARAM_MAPPING_SYNCHRO

__PARAM_MAPPING_METADATA_REF

__PARAM_MAPPING_ATTRIBUTE

__PARAM_CRITERIA

__PARAM_CRITERIA_CRITERION

__PARAM_CRITERIA_CRITERION_ID

__PARAM_CRITERIA_CRITERION_LABEL

__PARAM_CRITERIA_CRITERION_TYPE

__PARAM_COLUMNS

__PARAM_COLUMNS_COLUMN

_odfLang

_idColumn

_mapping

_extFields

_syncFields

_columns

_criteria

_context

_apogeeDAO

_jsonUtils

_sccDAO

_odfHelper

_apogeeSCCHelper

Constructor Detail

AbstractApogeeSynchronizableContentsCollection

Method Detail

service

contextualize

configureDataSource

_getCriterionLabel

populate

_internalPopulate

internalSearch

getRemoteValues

_importOrSynchronizeContent

importContent

synchronizeContent

putIdParameter

_search

_convertBigDecimal

_convertBigDecimal

_transformClobToString

getClobColumns

_transformListOfMap2MapOfList

getMappingName

getDataSourceId

getYear

addUnexistingChildren

getIdColumn

getIdField

getLocalAndExternalFields

getExternalOnlyFields

_fillContent

_fillRichTexts

_setRichTextValue

_handleAdditionalMetadata

getRichTextFields

configureSearchModel

additionalCommonOperations

handleParent

handleChildren

getChildrenSCCModelId