Package org.ametys.cms.contenttype
Class ContentTypeEnumerator
- java.lang.Object
-
- org.ametys.cms.contenttype.ContentTypeEnumerator
-
- All Implemented Interfaces:
Enumerator<String>
,Enumerator
,Configurable
,Serviceable
- Direct Known Subclasses:
AvailableContentTypesEnumerator
,CalendarContentTypesEnumerator
,ContentTypesForSearchEnumerator
public class ContentTypeEnumerator extends Object implements Enumerator<String>, Enumerator, Serviceable, Configurable
Enumerator forContentType
-
-
Field Summary
Fields Modifier and Type Field Description protected String
_allOption
All option : 'disabled' to disable the 'all' option, 'blank' to use a blank value for 'all' option, or 'concat' to concat all content types' ids for 'all' optionprotected String[]
_contentTypes
The parent content typesprotected ContentTypeExtensionPoint
_cTypeExtPt
The content type extension pointprivate ContentTypesTreeComponent
_cTypeTreeComponent
protected boolean
_excludeAbstract
True to exclude abstract content typesprotected boolean
_excludeMixin
True to exclude mixin content typesprotected boolean
_excludePrivate
True to exclude private content typesprotected boolean
_excludeReferenceTable
True to exclude reference table content typesprotected boolean
_mixinOnly
True to include only mixin content typesprotected boolean
_referenceTableOnly
True to include only reference table content typesprotected String[]
_strictContentTypes
The strict content types
-
Constructor Summary
Constructors Constructor Description ContentTypeEnumerator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
_handleAllOptionEntry(Map<String,I18nizableText> entries)
Add the all option entry to the entry list if necessaryvoid
configure(Configuration configuration)
Map<String,Object>
getConfiguration()
Get the configuration of this enumeratorMap<Object,I18nizableText>
getEntries()
Provides the enumerated values with their optional label.I18nizableText
getEntry(String value)
Retrieves a single label from a value.protected Set<ContentType>
getMatchingContentTypes()
Get the matching content typesMap<String,I18nizableText>
getTypedEntries()
Provides the enumerated values with their optional label.void
service(ServiceManager smanager)
-
-
-
Field Detail
-
_cTypeExtPt
protected ContentTypeExtensionPoint _cTypeExtPt
The content type extension point
-
_allOption
protected String _allOption
All option : 'disabled' to disable the 'all' option, 'blank' to use a blank value for 'all' option, or 'concat' to concat all content types' ids for 'all' option
-
_excludePrivate
protected boolean _excludePrivate
True to exclude private content types
-
_excludeReferenceTable
protected boolean _excludeReferenceTable
True to exclude reference table content types
-
_excludeAbstract
protected boolean _excludeAbstract
True to exclude abstract content types
-
_excludeMixin
protected boolean _excludeMixin
True to exclude mixin content types
-
_mixinOnly
protected boolean _mixinOnly
True to include only mixin content types
-
_referenceTableOnly
protected boolean _referenceTableOnly
True to include only reference table content types
-
_contentTypes
protected String[] _contentTypes
The parent content types
-
_strictContentTypes
protected String[] _strictContentTypes
The strict content types
-
_cTypeTreeComponent
private ContentTypesTreeComponent _cTypeTreeComponent
-
-
Constructor Detail
-
ContentTypeEnumerator
public ContentTypeEnumerator()
-
-
Method Detail
-
service
public void service(ServiceManager smanager) throws ServiceException
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
configure
public void configure(Configuration configuration) throws ConfigurationException
- Specified by:
configure
in interfaceConfigurable
- Throws:
ConfigurationException
-
getConfiguration
public Map<String,Object> getConfiguration()
Description copied from interface:Enumerator
Get the configuration of this enumerator- Specified by:
getConfiguration
in interfaceEnumerator<String>
- Specified by:
getConfiguration
in interfaceEnumerator
- Returns:
- the configuration
-
getEntries
public Map<Object,I18nizableText> getEntries() throws Exception
Description copied from interface:Enumerator
Provides the enumerated values with their optional label.- Specified by:
getEntries
in interfaceEnumerator
- Returns:
- the enumerated values and their label.
- Throws:
Exception
- if an error occurs.
-
getTypedEntries
public Map<String,I18nizableText> getTypedEntries() throws Exception
Description copied from interface:Enumerator
Provides the enumerated values with their optional label.- Specified by:
getTypedEntries
in interfaceEnumerator<String>
- Returns:
- the enumerated values and their label.
- Throws:
Exception
- if an error occurs. TODO NEWATTRIBUTEAPI: rename this method whenEnumerator
will be removed
-
getMatchingContentTypes
protected Set<ContentType> getMatchingContentTypes()
Get the matching content types- Returns:
- the matching content types
-
_handleAllOptionEntry
protected void _handleAllOptionEntry(Map<String,I18nizableText> entries)
Add the all option entry to the entry list if necessary- Parameters:
entries
- The enumerator entries
-
getEntry
public I18nizableText getEntry(String value) throws Exception
Description copied from interface:Enumerator
Retrieves a single label from a value.- Specified by:
getEntry
in interfaceEnumerator<String>
- Specified by:
getEntry
in interfaceEnumerator
- Parameters:
value
- the value.- Returns:
- the label or
null
if not found. - Throws:
Exception
- if an error occurs.
-
-