org.ametys.odf.tree

Class OdfClassificationHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.tree.OdfClassificationHandler

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class OdfClassificationHandler
extends AbstractLogEnabled
implements Component, Initializable, Serviceable

Component providing methods to retrieve ODF virtual pages, such as the ODF root, level 1 and 2 metadata names, and so on.

Field Summary

Fields

Modifier and Type	Field and Description
protected CatalogsManager	_catalogsManager The ODF Catalog enumeration
protected ContentHelper	_contentHelper Content helper
protected ContentTypesHelper	_contentTypesHelper Content types helper
protected ContentTypeExtensionPoint	_cTypeEP The content type extension point.
protected I18nUtils	_i18nUtils The i18n utils.
protected Map<String,Map<String,String>>	_levelValuesCache Level values cache.
protected ServiceManager	_manager Avalon service manager
protected OdfReferenceTableHelper	_odfReferenceTableHelper Odf reference table helper
protected RootOrgUnitProvider	_orgUnitProvider Root orgunit provider
protected AmetysObjectResolver	_resolver The ametys object resolver.
protected WorkspaceSelector	_workspaceSelector The workspace selector.
static String	CATALOG_METADATA_NAME Catalog metadata name.
protected static String	DEFAULT_LEVEL1_METADATA The default level 1 metadata.
protected static String	DEFAULT_LEVEL2_METADATA The default level 2 metadata.
static String	LEVEL1_METADATA_NAME First level metadata name.
static String	LEVEL2_METADATA_NAME Second level metadata name.
protected static List<String>	NON_ELIGIBLE_CTYPES_FOR_LEVEL Content types that are not eligible for first and second level
static String	ROLE The avalon role.

Constructor Summary

Constructors

Constructor and Description
OdfClassificationHandler()

Method Summary

Modifier and Type	Method and Description
private Stream<Map.Entry<String,MetadataDefinition>>	_collectEligibleChildMetadata(MetadataDefinitionHolder parentMetaDef, String prefix, boolean allowMultiple)
private String	_convertLevel2RawForContent(String levelValue)
private String	_convertLevel2RawForOrgUnit(String lang, String levelValue)
private String	_convertLevel2RawForRefTable(String metaContentType, String levelValue)
private String	_convertLevelValue2RawValue(String lang, String levelMeta, String levelValue) Convert a level value to the raw value
private String	_convertRaw2LevelForContent(String contentId)
private String	_convertRaw2LevelForOrgUnit(String orgUnitId)
private String	_convertRaw2LevelForRefTable(String tableRefId, String contentId)
protected String	_convertRawValue2LevelValue(String metadataPath, String rawLevelValue) Convert the metadata raw value into a level value
private Map<String,String>	_getLevelValues(String metadata, String language) Get the available values of a program's metadata to be used as a level in the virtual odf page hierarchy.
private Map<String,String>	_getLevelValuesForContentType(String metaContentType, String language)
private Map<String,String>	_getLevelValuesForEnumerator(String language, Enumerator enumerator)
private Map<String,String>	_getLevelValuesForOrgUnits()
private Map<String,String>	_getLevelValuesForRefTable(String metaContentType, String language)
private boolean	_isEligibleMetadata(MetadataDefinition metaDef, boolean allowMultiple)
void	clearLevelValues() Clear the cache of available values for levels used for ODF virtual pages
void	clearLevelValues(String metadataPath, String lang) Clear the cache of available values for level
String	decodeLevelValue(String value) Decode level value used in a URI
String	encodeLevelValue(String value) Encode level value to be use into a URI.
Map<String,I18nizableText>	getCatalogs() Get the ODF catalogs
Map<String,MetadataDefinition>	getEligibleMetadataForLevel() Get the eligible enumerated metadata for ODF page level
Map<String,MetadataDefinition>	getEnumeratedMetadata(String programContentTypeId, boolean allowMultiple) Get the enumerated metadata definition for the given content type.
Map<String,String>	getLevelValues(String metadata, String language) Get the first level metadata values (with translated label).
String	getOrgunitIdFromUaiCode(String lang, String uaiCode) Get the orgunit identifier given an uai code
List<String>	getProgramLevelRawValues(Program program, String levelMetaPath) Get the level value of a program by extracting and transforming the raw program value at the desired metadata path
List<String>	getProgramLevelValues(Program program, String levelMetaPath) Get the level value of a program by extracting and transforming the raw program value at the desired metadata path
AmetysObjectIterable<Program>	getPrograms(String catalog, String lang, String level1MetaPath, String level1, String level2MetaPath, String level2, String programCode, String programName, Collection<Expression> additionalExpressions) Get a collection of programs corresponding to following parameters.
void	initialize()
boolean	isEligibleMetadataForLevel(String metadataPath, boolean allowMultiple) True if the program metadata is eligible
Map<String,Map<String,Collection<Program>>>	organizeProgramsByLevels(AmetysObjectIterable<Program> programs, String level1, String level2) Organize passed programs by levels into a Map.
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The avalon role.

LEVEL1_METADATA_NAME

public static final String LEVEL1_METADATA_NAME

First level metadata name.

See Also:

Constant Field Values

LEVEL2_METADATA_NAME

public static final String LEVEL2_METADATA_NAME

Second level metadata name.

See Also:

Constant Field Values

CATALOG_METADATA_NAME

public static final String CATALOG_METADATA_NAME

Catalog metadata name.

See Also:

Constant Field Values

DEFAULT_LEVEL1_METADATA

protected static final String DEFAULT_LEVEL1_METADATA

The default level 1 metadata.

See Also:

Constant Field Values

DEFAULT_LEVEL2_METADATA

protected static final String DEFAULT_LEVEL2_METADATA

The default level 2 metadata.

See Also:

Constant Field Values

NON_ELIGIBLE_CTYPES_FOR_LEVEL

protected static final List<String> NON_ELIGIBLE_CTYPES_FOR_LEVEL

Content types that are not eligible for first and second level

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point.

_catalogsManager

protected CatalogsManager _catalogsManager

The ODF Catalog enumeration

_levelValuesCache

protected Map<String,Map<String,String>> _levelValuesCache

Level values cache.

_workspaceSelector

protected WorkspaceSelector _workspaceSelector

The workspace selector.

_manager

protected ServiceManager _manager

Avalon service manager

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

Content types helper

_contentHelper

protected ContentHelper _contentHelper

Content helper

_odfReferenceTableHelper

protected OdfReferenceTableHelper _odfReferenceTableHelper

Odf reference table helper

_orgUnitProvider

protected RootOrgUnitProvider _orgUnitProvider

Root orgunit provider

Constructor Detail

OdfClassificationHandler

public OdfClassificationHandler()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getCatalogs

public Map<String,I18nizableText> getCatalogs()

Get the ODF catalogs

Returns:

the ODF catalogs

isEligibleMetadataForLevel

public boolean isEligibleMetadataForLevel(String metadataPath,
                                          boolean allowMultiple)

True if the program metadata is eligible

Parameters:

metadataPath - the metadata path

allowMultiple - true is we allow multiple metadata

Returns:

true if the program metadata is eligible

getEligibleMetadataForLevel

public Map<String,MetadataDefinition> getEligibleMetadataForLevel()

Get the eligible enumerated metadata for ODF page level

Returns:

the eligible metadata definition

getEnumeratedMetadata

public Map<String,MetadataDefinition> getEnumeratedMetadata(String programContentTypeId,
                                                            boolean allowMultiple)

Get the enumerated metadata definition for the given content type. Metadata with enumerator or content metadata are considered as enumrated

Parameters:

programContentTypeId - The content type's id

allowMultiple - true true to allow multiple metadata

Returns:

The definition of enumerated metadata

_collectEligibleChildMetadata

private Stream<Map.Entry<String,MetadataDefinition>> _collectEligibleChildMetadata(MetadataDefinitionHolder parentMetaDef,
                                                                                   String prefix,
                                                                                   boolean allowMultiple)

_isEligibleMetadata

private boolean _isEligibleMetadata(MetadataDefinition metaDef,
                                    boolean allowMultiple)

getProgramLevelValues

public List<String> getProgramLevelValues(Program program,
                                          String levelMetaPath)

Get the level value of a program by extracting and transforming the raw program value at the desired metadata path

Parameters:

program - The program

levelMetaPath - The desired metadata path that represent a level

Returns:

The list of final level values

getProgramLevelRawValues

public List<String> getProgramLevelRawValues(Program program,
                                             String levelMetaPath)

Get the level value of a program by extracting and transforming the raw program value at the desired metadata path

Parameters:

program - The program

levelMetaPath - The desired metadata path that represent a level

Returns:

The list of level raw value

_convertRawValue2LevelValue

protected String _convertRawValue2LevelValue(String metadataPath,
                                             String rawLevelValue)

Convert the metadata raw value into a level value

Parameters:

metadataPath - The path of the metadata corresponding to the level

rawLevelValue - The raw level value

Returns:

the converted value or null if there is no level value for this raw value

_convertRaw2LevelForRefTable

private String _convertRaw2LevelForRefTable(String tableRefId,
                                            String contentId)

_convertRaw2LevelForOrgUnit

private String _convertRaw2LevelForOrgUnit(String orgUnitId)

_convertRaw2LevelForContent

private String _convertRaw2LevelForContent(String contentId)

_convertLevel2RawForRefTable

private String _convertLevel2RawForRefTable(String metaContentType,
                                            String levelValue)

_convertLevel2RawForContent

private String _convertLevel2RawForContent(String levelValue)

clearLevelValues

public void clearLevelValues()

Clear the cache of available values for levels used for ODF virtual pages

clearLevelValues

public void clearLevelValues(String metadataPath,
                             String lang)

Clear the cache of available values for level

Parameters:

lang - the language

metadataPath - the path of level's metadata

getLevelValues

public Map<String,String> getLevelValues(String metadata,
                                         String language)

Get the first level metadata values (with translated label).

Parameters:

metadata - Metadata of first level

language - Lang to get

Returns:

the first level metadata values.

encodeLevelValue

public String encodeLevelValue(String value)

Encode level value to be use into a URI. Double-encode characters ':', '-' and '/'.

Parameters:

value - The raw value

Returns:

the encoded value

decodeLevelValue

public String decodeLevelValue(String value)

Decode level value used in a URI

Parameters:

value - The encoded value

Returns:

the decoded value

_getLevelValues

private Map<String,String> _getLevelValues(String metadata,
                                           String language)

Get the available values of a program's metadata to be used as a level in the virtual odf page hierarchy.

Parameters:

metadata - the metadata path.

language - the language.

Returns:

the available metadata values.

_getLevelValuesForRefTable

private Map<String,String> _getLevelValuesForRefTable(String metaContentType,
                                                      String language)

_getLevelValuesForOrgUnits

private Map<String,String> _getLevelValuesForOrgUnits()

_getLevelValuesForContentType

private Map<String,String> _getLevelValuesForContentType(String metaContentType,
                                                         String language)

_getLevelValuesForEnumerator

private Map<String,String> _getLevelValuesForEnumerator(String language,
                                                        Enumerator enumerator)
                                                 throws Exception

Throws:

Exception

getPrograms

public AmetysObjectIterable<Program> getPrograms(String catalog,
                                                 String lang,
                                                 String level1MetaPath,
                                                 String level1,
                                                 String level2MetaPath,
                                                 String level2,
                                                 String programCode,
                                                 String programName,
                                                 Collection<Expression> additionalExpressions)

Get a collection of programs corresponding to following parameters.

Parameters:

catalog - Name of the catalog. Can be null to get all programs matching other arguments.

lang - the content language. Can not be null.

level1MetaPath - Having a non-empty value for the metadata path

level1 - If this parameter is not null or empty and level1MetaPath too, we filter programs by the metadata level1MetaPath value of level1

level2MetaPath - Having a non-empty value for the metadata path

level2 - If this parameter is not null or empty and level2MetaPath too, we filter programs by the metadata level2MetaPath value of level2

programCode - The program's code. Can be null to get all programs matching other arguments.

programName - The program's name. Can be null to get all programs matching other arguments.

additionalExpressions - Additional expressions to add to search

Returns:

A collection of programs

getOrgunitIdFromUaiCode

public String getOrgunitIdFromUaiCode(String lang,
                                      String uaiCode)

Get the orgunit identifier given an uai code

Parameters:

lang - Language

uaiCode - The uai code

Returns:

The orgunit id or null if not found

_convertLevelValue2RawValue

private String _convertLevelValue2RawValue(String lang,
                                           String levelMeta,
                                           String levelValue)

Convert a level value to the raw value

Parameters:

lang - The language

levelMeta - The name of metadata holding the level

levelValue - The level value

Returns:

The raw value

_convertLevel2RawForOrgUnit

private String _convertLevel2RawForOrgUnit(String lang,
                                           String levelValue)

organizeProgramsByLevels

public Map<String,Map<String,Collection<Program>>> organizeProgramsByLevels(AmetysObjectIterable<Program> programs,
                                                                            String level1,
                                                                            String level2)
                                                                     throws SAXException

Organize passed programs by levels into a Map.

Parameters:

programs - Programs to organize

level1 - Name of the metadata of first level

level2 - Name of the metadata of second level

Returns:

A Map of Map with a Collection of programs which representing the organization of programs by levels.

Throws:

SAXException - if an error occured