org.ametys.odf.enumeration

Class OdfReferenceTableHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.enumeration.OdfReferenceTableHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class OdfReferenceTableHelper
extends AbstractLogEnabled
implements Component, Serviceable

This component handles ODF reference tables

Field Summary

Fields

Modifier and Type	Field and Description
private ContentTypeExtensionPoint	_cTypeEP
private ContentTypesHelper	_cTypeHelper
private AmetysObjectResolver	_resolver
static String	ABSTRACT_MENTION Mention licence
static String	ABSTRACT_TABLE_REF Abstract table ref
static String	ABSTRACT_TABLE_REF_CATEGORY Abstract table ref for category
static String	APPRENTICESHIP_CONTRACT Apprenticeship contract
static String	AVAILABLE_CERTIFICATION Available certification
static String	CAMPUS Campus
static String	CODE_CITE97 Code Cite97
static String	CODE_DGESIP Code DGESIP
static String	CODE_ERASMUS Code ERASMUS
static String	CODE_ERASMUS_CATEGORY Category for code Erasmus
static String	CODE_FAP Code FAP
static String	CODE_FAP_CATEGORY Category for code FAP
static String	CODE_NSF Code NSF
static String	CODE_ROME Code ROME
static String	CODE_SISE Code SISE
static String	CONTAINER_NATURE Nature of container
static String	COURSE_NATURE Nature of course
static String	DEGREE Degree
static String	DISCIPLINE Discipline
static String	DISTANCE_LEARNING_MODALITIES Distance learning modalities
static String	DOMAIN Domain
static String	DURATION Duration
static String	ECTS ECTS
static String	ENSEIGNEMENT_NATURE Nature of course part
static String	ENSEIGNEMENT_NATURE_CATEGORY Category of nature of course part
static String	FOREIGN_PLACE Foreign place
static String	FORMOFTEACHING_METHOD Form of teaching
static String	FORMOFTEACHING_ORG Orgnization of teaching
static String	INTERNATIONAL_EDUCATION International education
static String	INTERNSHIP Type of training course
static String	JOIN_ORGUNIT Join orgunit
static String	LANGUAGE Language
static String	LEVEL Level
static String	MENTION_LICENCE Mention licence
static String	MENTION_LICENCEPRO Mention licence pro
static String	MENTION_MASTER Mention master
static String	ORGUNIT_TYPE OrgUnit type
static String	PERIOD Period
static String	PERSON_ROLE Person role
static String	PLACE Place
static String	PROGRAM_FIELD Program field
static String	PROGRAM_TYPE Program type.
static String	RNCP_LEVEL RNCP level
static String	ROLE Avalon Role
static String	SECTORS Sectors
static String	SKILL Skill
static String	SKILL_SET Skill set
static String	TEACHING_ACTIVITY Teaching method
static String	TEACHING_TERM Teaching term.
static String	TIME_SLOT Time slot

Constructor Summary

Constructors

Constructor and Description
OdfReferenceTableHelper()

Method Summary

Modifier and Type	Method and Description
private Map<String,MetadataDefinition>	_getTableRefMetadata(AbstractMetadataSetElement element, MetadataDefinitionHolder parentMetaDef, String prefix)
private Map<String,MetadataDefinition>	_getTableRefMetadata(MetadataDefinitionHolder parentMetaDef, String prefix)
private void	_saxItems(ContentHandler contentHandler, AttributesImpl rootAttrs, String tableRefId)
String	getCDMfrValue(String tableRefId, String code) Get the CDM-fr value associated with the given code
String	getItemCDMfrValue(String contentId, boolean returnCodeIfEmpty) Returns the CMD value of an reference table entry
String	getItemCDMfrValue(String tableRefId, String contentId, boolean returnCodeIfEmpty) Deprecated. Use getItemCDMfrValue(String, boolean) instead
String	getItemCode(String contentId) Returns the code of an reference table entry from its CDM value
String	getItemCode(String tableRefId, String contentId) Deprecated. Use getItemCode(String) instead
String	getItemCodeFromCDM(String tableRefId, String cdmValue) Returns the code of an reference table entry from its CDM value
OdfReferenceTableEntry	getItemFromCDM(String tableRefId, String cdmValue) Returns the entry of an reference table entry from its cdmValue
OdfReferenceTableEntry	getItemFromCode(String tableRefId, String code) Returns the entry of an reference table entry from its code
String	getItemLabel(String contentId, String lang) Returns the label of an reference table entry
String	getItemLabel(String tableRefId, String contentId, String lang) Deprecated. Use getItemLabel(String, String) instead
List<OdfReferenceTableEntry>	getItems(String tableRefId) Get all items of an enumeration and their label
Map<String,String>	getMentionContentTypes(List<String> degreeIds) Get the content type for mention for this degree
String	getMentionForDegree(String degreeId) Get the mention for a given degree.
Set<String>	getTableReferenceIds() Get the id of table references
Map<String,MetadataDefinition>	getTableRefMetadataDefinition(String cTypeId) Get the metadata definitions for table references for a given content type
Map<String,MetadataDefinition>	getTableRefMetadataDefinition(String cTypeId, String medatataSetName, boolean isEditionMetadataSet) Get the metadata definitions for table references for a given content type and a metadata set
boolean	isTableReference(String cTypeId) Determines if the content type is a ODF table reference
boolean	isTableReferenceEntry(Content content) Determines if the content is an entry of a ODF table reference
void	saxItems(ContentHandler contentHandler, MetadataDefinition metaDef) SAX items of a reference table
void	saxItems(ContentHandler contentHandler, String tableRefId) SAX items of a reference table
void	service(ServiceManager manager)

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

Avalon Role

ABSTRACT_TABLE_REF

public static final String ABSTRACT_TABLE_REF

Abstract table ref

See Also:

Constant Field Values

DOMAIN

public static final String DOMAIN

Domain

See Also:

Constant Field Values

DEGREE

public static final String DEGREE

Degree

See Also:

Constant Field Values

LEVEL

public static final String LEVEL

Level

See Also:

Constant Field Values

PROGRAM_TYPE

public static final String PROGRAM_TYPE

Program type.

See Also:

Constant Field Values

FORMOFTEACHING_METHOD

public static final String FORMOFTEACHING_METHOD

Form of teaching

See Also:

Constant Field Values

FORMOFTEACHING_ORG

public static final String FORMOFTEACHING_ORG

Orgnization of teaching

See Also:

Constant Field Values

TEACHING_ACTIVITY

public static final String TEACHING_ACTIVITY

Teaching method

See Also:

Constant Field Values

INTERNSHIP

public static final String INTERNSHIP

Type of training course

See Also:

Constant Field Values

DISTANCE_LEARNING_MODALITIES

public static final String DISTANCE_LEARNING_MODALITIES

Distance learning modalities

See Also:

Constant Field Values

PLACE

public static final String PLACE

Place

See Also:

Constant Field Values

TEACHING_TERM

public static final String TEACHING_TERM

Teaching term.

See Also:

Constant Field Values

TIME_SLOT

public static final String TIME_SLOT

Time slot

See Also:

Constant Field Values

CODE_ROME

public static final String CODE_ROME

Code ROME

See Also:

Constant Field Values

CODE_ERASMUS

public static final String CODE_ERASMUS

Code ERASMUS

See Also:

Constant Field Values

CODE_DGESIP

public static final String CODE_DGESIP

Code DGESIP

See Also:

Constant Field Values

CODE_SISE

public static final String CODE_SISE

Code SISE

See Also:

Constant Field Values

CODE_CITE97

public static final String CODE_CITE97

Code Cite97

See Also:

Constant Field Values

CODE_FAP

public static final String CODE_FAP

Code FAP

See Also:

Constant Field Values

CODE_NSF

public static final String CODE_NSF

Code NSF

See Also:

Constant Field Values

RNCP_LEVEL

public static final String RNCP_LEVEL

RNCP level

See Also:

Constant Field Values

JOIN_ORGUNIT

public static final String JOIN_ORGUNIT

Join orgunit

See Also:

Constant Field Values

ABSTRACT_MENTION

public static final String ABSTRACT_MENTION

Mention licence

See Also:

Constant Field Values

MENTION_LICENCE

public static final String MENTION_LICENCE

Mention licence

See Also:

Constant Field Values

MENTION_LICENCEPRO

public static final String MENTION_LICENCEPRO

Mention licence pro

See Also:

Constant Field Values

MENTION_MASTER

public static final String MENTION_MASTER

Mention master

See Also:

Constant Field Values

ABSTRACT_TABLE_REF_CATEGORY

public static final String ABSTRACT_TABLE_REF_CATEGORY

Abstract table ref for category

See Also:

Constant Field Values

APPRENTICESHIP_CONTRACT

public static final String APPRENTICESHIP_CONTRACT

Apprenticeship contract

See Also:

Constant Field Values

AVAILABLE_CERTIFICATION

public static final String AVAILABLE_CERTIFICATION

Available certification

See Also:

Constant Field Values

CAMPUS

public static final String CAMPUS

Campus

See Also:

Constant Field Values

CODE_ERASMUS_CATEGORY

public static final String CODE_ERASMUS_CATEGORY

Category for code Erasmus

See Also:

Constant Field Values

CODE_FAP_CATEGORY

public static final String CODE_FAP_CATEGORY

Category for code FAP

See Also:

Constant Field Values

CONTAINER_NATURE

public static final String CONTAINER_NATURE

Nature of container

See Also:

Constant Field Values

COURSE_NATURE

public static final String COURSE_NATURE

Nature of course

See Also:

Constant Field Values

DISCIPLINE

public static final String DISCIPLINE

Discipline

See Also:

Constant Field Values

DURATION

public static final String DURATION

Duration

See Also:

Constant Field Values

ECTS

public static final String ECTS

ECTS

See Also:

Constant Field Values

FOREIGN_PLACE

public static final String FOREIGN_PLACE

Foreign place

See Also:

Constant Field Values

INTERNATIONAL_EDUCATION

public static final String INTERNATIONAL_EDUCATION

International education

See Also:

Constant Field Values

LANGUAGE

public static final String LANGUAGE

Language

See Also:

Constant Field Values

ORGUNIT_TYPE

public static final String ORGUNIT_TYPE

OrgUnit type

See Also:

Constant Field Values

PERIOD

public static final String PERIOD

Period

See Also:

Constant Field Values

PERSON_ROLE

public static final String PERSON_ROLE

Person role

See Also:

Constant Field Values

PROGRAM_FIELD

public static final String PROGRAM_FIELD

Program field

See Also:

Constant Field Values

SECTORS

public static final String SECTORS

Sectors

See Also:

Constant Field Values

ENSEIGNEMENT_NATURE

public static final String ENSEIGNEMENT_NATURE

Nature of course part

See Also:

Constant Field Values

ENSEIGNEMENT_NATURE_CATEGORY

public static final String ENSEIGNEMENT_NATURE_CATEGORY

Category of nature of course part

See Also:

Constant Field Values

SKILL

public static final String SKILL

Skill

See Also:

Constant Field Values

SKILL_SET

public static final String SKILL_SET

Skill set

See Also:

Constant Field Values

_resolver

private AmetysObjectResolver _resolver

_cTypeEP

private ContentTypeExtensionPoint _cTypeEP

_cTypeHelper

private ContentTypesHelper _cTypeHelper

Constructor Detail

OdfReferenceTableHelper

public OdfReferenceTableHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isTableReference

public boolean isTableReference(String cTypeId)

Determines if the content type is a ODF table reference

Parameters:

cTypeId - The id of content type

Returns:

true if the content type is a ODF table reference

isTableReferenceEntry

public boolean isTableReferenceEntry(Content content)

Determines if the content is an entry of a ODF table reference

Parameters:

content - The content

Returns:

true if the content is an entry of a ODF table reference

getTableReferenceIds

public Set<String> getTableReferenceIds()

Get the id of table references

Returns:

The content type's id

getTableRefMetadataDefinition

public Map<String,MetadataDefinition> getTableRefMetadataDefinition(String cTypeId)

Get the metadata definitions for table references for a given content type

Parameters:

cTypeId - The id of content type

Returns:

The metadata definitions for table references

getTableRefMetadataDefinition

public Map<String,MetadataDefinition> getTableRefMetadataDefinition(String cTypeId,
                                                                    String medatataSetName,
                                                                    boolean isEditionMetadataSet)

Get the metadata definitions for table references for a given content type and a metadata set

Parameters:

cTypeId - The id of content type

medatataSetName - the name of the metadata set. Cannot be null.

isEditionMetadataSet - true if the metadata set is for edition.

Returns:

The metadata definitions for table references

_getTableRefMetadata

private Map<String,MetadataDefinition> _getTableRefMetadata(MetadataDefinitionHolder parentMetaDef,
                                                            String prefix)

_getTableRefMetadata

private Map<String,MetadataDefinition> _getTableRefMetadata(AbstractMetadataSetElement element,
                                                            MetadataDefinitionHolder parentMetaDef,
                                                            String prefix)

getMentionContentTypes

public Map<String,String> getMentionContentTypes(List<String> degreeIds)

Get the content type for mention for this degree

Parameters:

degreeIds - The ids of degrees

Returns:

A map with the id of content type or null if there is no mention for this degree

getMentionForDegree

public String getMentionForDegree(String degreeId)

Get the mention for a given degree.

Parameters:

degreeId - The degree ID

Returns:

The associated mention reference table, null if there isn't

getCDMfrValue

public String getCDMfrValue(String tableRefId,
                            String code)

Get the CDM-fr value associated with the given code

Parameters:

tableRefId - The id of content type

code - The code

Returns:

The CDM-fr value or empty string if not found

getItems

public List<OdfReferenceTableEntry> getItems(String tableRefId)

Get all items of an enumeration and their label

Parameters:

tableRefId - The id of content type

Returns:

items of enumeration

getItemLabel

public String getItemLabel(String contentId,
                           String lang)

Returns the label of an reference table entry

Parameters:

contentId - The content id

lang - The requested language of label

Returns:

the item label or null if not found

getItemLabel

@Deprecated
public String getItemLabel(String tableRefId,
                                       String contentId,
                                       String lang)

Deprecated. Use getItemLabel(String, String) instead

Returns the label of an reference table entry

Parameters:

tableRefId - The id of content type (useless)

contentId - The content id

lang - The requested language of label

Returns:

the item label or null if not found

getItemCDMfrValue

public String getItemCDMfrValue(String contentId,
                                boolean returnCodeIfEmpty)

Returns the CMD value of an reference table entry

Parameters:

contentId - The content id

returnCodeIfEmpty - true to return the code if CDM-fr value is empty

Returns:

the CDM-fr value or empty value if not found

getItemCDMfrValue

@Deprecated
public String getItemCDMfrValue(String tableRefId,
                                            String contentId,
                                            boolean returnCodeIfEmpty)

Deprecated. Use getItemCDMfrValue(String, boolean) instead

Returns the CMD value of an reference table entry

Parameters:

tableRefId - The id of content type (useless)

contentId - The content id

returnCodeIfEmpty - true to return the code if CDM-fr value is empty

Returns:

the CDM-fr value or empty value if not found

getItemCode

public String getItemCode(String contentId)

Returns the code of an reference table entry from its CDM value

Parameters:

contentId - The id of content

Returns:

the code or empty value if not found

getItemCode

@Deprecated
public String getItemCode(String tableRefId,
                                      String contentId)

Deprecated. Use getItemCode(String) instead

Returns the code of an reference table entry from its CDM value

Parameters:

tableRefId - The id of content type (useless)

contentId - The id of content

Returns:

the code or empty value if not found

getItemCodeFromCDM

public String getItemCodeFromCDM(String tableRefId,
                                 String cdmValue)

Returns the code of an reference table entry from its CDM value

Parameters:

tableRefId - The id of content type

cdmValue - The CDM-fr value

Returns:

the code or null if not found

getItemFromCDM

public OdfReferenceTableEntry getItemFromCDM(String tableRefId,
                                             String cdmValue)

Returns the entry of an reference table entry from its cdmValue

Parameters:

tableRefId - The id of content type

cdmValue - The CDM-fr value

Returns:

the entry or null if not found

getItemFromCode

public OdfReferenceTableEntry getItemFromCode(String tableRefId,
                                              String code)

Returns the entry of an reference table entry from its code

Parameters:

tableRefId - The id of content type

code - The code

Returns:

the entry or null if not found

saxItems

public void saxItems(ContentHandler contentHandler,
                     String tableRefId)
              throws SAXException

SAX items of a reference table

Parameters:

contentHandler - The content handler to sax into

tableRefId - The id of reference table

Throws:

SAXException - if an error occurred while saxing

saxItems

public void saxItems(ContentHandler contentHandler,
                     MetadataDefinition metaDef)
              throws SAXException

SAX items of a reference table

Parameters:

contentHandler - the content handler to sax into

metaDef - the metadata definition

Throws:

SAXException - if an error occurs while saxing

_saxItems

private void _saxItems(ContentHandler contentHandler,
                       AttributesImpl rootAttrs,
                       String tableRefId)
                throws SAXException

Throws:

SAXException