AbstractApogeeSynchronizableContentsCollection (Ametys 4.2.x

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 and 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 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 String`	`_odfLang` Default language configured for ODF
`protected Set<String>`	`_syncFields` Synchronized fields
`static String`	`HANDLE_CONTENTS` Request attribute name to store handle contents during import or synchronization.

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

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

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

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

Constructor Summary

Constructors
Constructor and Description

AbstractApogeeSynchronizableContentsCollection()

Constructors
Constructor and Description
`AbstractApogeeSynchronizableContentsCollection()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected List<Map<String,Object>>`	`_convertBigDecimal(List<Map<String,Object>> searchResults)` Convert the `BigDecimal` values retrieved from database into long values
`protected Object`	`_convertBigDecimal(String contentTypeId, String metadataName, Object objectToConvert)` Convert the object in parameter to a long if it's a `BigDecimal`, otherwise return the object itself.
`protected boolean`	`_fillContent(Map<String,List<Object>> remoteValues, ModifiableDefaultContent content, boolean create, Logger logger)` Fill the content with remote values.
`private I18nizableText`	`_getCriterionLabel(Configuration configuration, String defaultValue)`
`private String`	`_getSort(List<Object> sortList)`
`protected boolean`	`_handleAdditionalMetadata(ModifiableCompositeMetadata holder, boolean create)` Method to add additional metadata on import or synchronize.
`protected ModifiableDefaultContent`	`_importContent(String idValue, Map<String,Object> importParams, String lang, Map<String,List<Object>> remoteValues, Logger logger)` Import a content from remote values.
`protected List<ModifiableDefaultContent>`	`_importOrSynchronizeContent(String idValue, Map<String,List<Object>> remoteValues, boolean forceImport, Logger logger)` Imports or synchronizes a content for each available language
`protected abstract List<Map<String,Object>>`	`_search(Map<String,Object> searchParams, Logger logger)` Search the contents with the search parameters.
`protected ModifiableDefaultContent`	`_synchronizeContent(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Logger logger)` Synchronize a content with remove values.
`protected Object`	`_transformClobToString(Object value, String idValue, Logger logger)` Transform CLOB value to String value.
`private Map<String,List<Object>>`	`_transformOrgUnitMetadata(Map<String,List<Object>> remoteValues, Logger logger)`
`protected boolean`	`additionalCommonOperations(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Map<String,Object> importParams, Logger logger)` Add specific fields to the content during import or synchronization.
`protected boolean`	`addToHandleContents(String contentId)` Add the content ID to the handle contents list.
`protected void`	`configureDataSource(Configuration configuration)` Configure the data source parameters.
`protected void`	`configureSearchModel()` Configure the search model used by SCCSearchTool.
`void`	`contextualize(Context context)`
`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, 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, Logger logger)` Return the total number of results for the search.
`protected boolean`	`handleChildren(ModifiableDefaultContent content, Logger logger)` Set the children metadata and invert relation, import and synchronize the children too.
`protected boolean`	`handleParent(ModifiableDefaultContent currentContent, ModifiableDefaultContent parentContent, 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, Logger logger)` Import a content from remote values.
`protected boolean`	`importOrSynchronizeChildren(ModifiableDefaultContent content, String sccModelId, String metadataName, String invertMetadataName, 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, 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, Logger logger)` Search values and return the result without any treatment.
`List<ModifiableDefaultContent>`	`populate(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, Logger logger)` Set the additional metadata.
`void`	`synchronizeContent(ModifiableDefaultContent content, Logger logger)` Synchronize a content with remove values.

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

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection
_getContentPathQuery, _getExpressionsList, _getMetadataHolder, _isParamNotEmpty, _removeEmptyParameters, _removeMetadataIfExists, _synchronizeMetadata, _updateRelation, _updateRelation, applyChanges, applyChanges, createContentAction, deleteUnexistingContents, 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
  - HANDLE_CONTENTS
```
public static final String HANDLE_CONTENTS
```
    Request attribute name to store handle contents during import or synchronization.
  - __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
- 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(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)
  - internalSearch
```
protected Map<String,Map<String,Object>> internalSearch(Map<String,Object> parameters,
                                                        int offset,
                                                        int limit,
                                                        List<Object> sort,
                                                        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,
                                                               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,
                                                                     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,
                                                    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,
                               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,
                                                    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 metadataName,
                                    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
    
    metadataName - The metadata name
    
    objectToConvert - The object to convert if necessary
    
    Returns:
    
    The converted object
  - _transformClobToString
```
protected Object _transformClobToString(Object value,
                                        String idValue,
                                        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.
  - getMappingName
```
protected abstract String getMappingName()
```
    Get the name of the mapping.
    
    Returns:
    
    the mapping name
  - 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,
                               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
  - _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,
                                             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
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - handleParent
```
protected boolean handleParent(ModifiableDefaultContent currentContent,
                               ModifiableDefaultContent parentContent,
                               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,
                                 Logger logger)
```
    Set the children metadata and invert relation, import and synchronize the children too.
    
    Parameters:
    
    content - Current content
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - setAdditionalMetadata
```
protected boolean setAdditionalMetadata(ModifiableDefaultContent content,
                                        Map<String,List<Object>> remoteValues,
                                        Logger logger)
```
    Set the additional metadata.
    
    Parameters:
    
    content - Current content
    
    remoteValues - Values of the content
    
    logger - The logger
    
    Returns:
    
    true if there are changes
  - _getSort
```
private String _getSort(List<Object> sortList)
```
  - getTotalCount
```
public int getTotalCount(Map<String,Object> parameters,
                         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,
                                                  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,
                                                       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,
                                              Logger logger)
```
    Import and synchronize children of the given content, then edit the structure of the content and its children.
    
    Parameters:
    
    content - Parent content
    
    sccModelId - SCC model ID
    
    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,
                                                                  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)
  - addToHandleContents
```
protected boolean addToHandleContents(String contentId)
```
    Add the content ID to the handle contents list.
    
    Parameters:
    
    contentId - Content ID
    
    Returns:
    
    true if the content ID have been added, false is returned if the content ID already exists in the handle contents list.
  - _transformOrgUnitMetadata
```
private Map<String,List<Object>> _transformOrgUnitMetadata(Map<String,List<Object>> remoteValues,
                                                           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

HANDLE_CONTENTS

__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

Constructor Detail

AbstractApogeeSynchronizableContentsCollection

Method Detail

service

contextualize

configureDataSource

_getCriterionLabel

populate

internalSearch

getRemoteValues

_importOrSynchronizeContent

importContent

synchronizeContent

putIdParameter

_search

_convertBigDecimal

_convertBigDecimal

_transformClobToString

getMappingName

getIdColumn

getIdField

getLocalAndExternalFields

getExternalOnlyFields

_fillContent

_handleAdditionalMetadata

getRichTextFields

configureSearchModel

additionalCommonOperations

handleParent

handleChildren

setAdditionalMetadata

_getSort

getTotalCount

_importContent

_synchronizeContent

importOrSynchronizeChildren

importOrSynchronizeContents

addToHandleContents

_transformOrgUnitMetadata

handleRightAssignmentContext