Package org.opencms.db.urlname
Class CmsUrlNameMappingFilter
java.lang.Object
org.opencms.db.urlname.CmsUrlNameMappingFilter
A class which contains filter criteria for reading or deleting URL name mapping entries.
- Since:
- 8.0.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final CmsUrlNameMappingFilter
Base filter which matches all URL name mapping entries. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
The default constructor.protected
The copy constructor. -
Method Summary
Modifier and TypeMethodDescriptionfilterLocale
(String locale) Returns a new url name mapping filter based on the current one which also has to match a given locale.filterName
(String name) Creates a new filter from the current filter which also has to match a given name.filterNamePattern
(String namePattern) Creates a new filter from the current filter which also has to match a given name pattern.Creates a new filter from the current filter which also must not match a given structure id.filterStates
(int... states) Creates a new filter from the current filter which also has to match a given state.filterStructureId
(CmsUUID structureId) Creates a new filter from the current filter which also has to match a given structure id.Returns the locale which should be matched by the filter.getName()
Returns the name which should be matched by the filter.Returns the name pattern which should be matched by the filter.Returns the structure id which should not be matched by the filter.int[]
Returns the state which should be matched by the filter.Returns the structure id which should be matched by the filter.boolean
Checks whether this is a filter which only filters by structure id.boolean
Checks whether this is a filter which only filters by name.toString()
-
Field Details
-
ALL
Base filter which matches all URL name mapping entries.
-
-
Constructor Details
-
CmsUrlNameMappingFilter
protected CmsUrlNameMappingFilter()The default constructor. -
CmsUrlNameMappingFilter
The copy constructor.- Parameters:
filter
- the filter to copy
-
-
Method Details
-
filterLocale
Returns a new url name mapping filter based on the current one which also has to match a given locale.- Parameters:
locale
- the locale to match- Returns:
- the new filter
-
filterName
Creates a new filter from the current filter which also has to match a given name.- Parameters:
name
- the name to match- Returns:
- a new filter
-
filterNamePattern
Creates a new filter from the current filter which also has to match a given name pattern.- Parameters:
namePattern
- the name pattern which should be matched- Returns:
- a new filter
-
filterRejectStructureId
Creates a new filter from the current filter which also must not match a given structure id.- Parameters:
id
- the structure id to not match- Returns:
- a new filter
-
filterStates
Creates a new filter from the current filter which also has to match a given state.- Parameters:
states
- the states to match- Returns:
- the new filter
-
filterStructureId
Creates a new filter from the current filter which also has to match a given structure id.- Parameters:
structureId
- the structure id to match- Returns:
- the new filter
-
getLocale
Returns the locale which should be matched by the filter.- Returns:
- the locale
-
getName
Returns the name which should be matched by the filter.- Returns:
- the name which should be matched by the filter
-
getNamePattern
Returns the name pattern which should be matched by the filter.- Returns:
- the name pattern which should be matched by the filter
-
getRejectStructureId
Returns the structure id which should not be matched by the filter.- Returns:
- a structure id
-
getStates
Returns the state which should be matched by the filter.- Returns:
- the state which should be matched by the filter
-
getStructureId
Returns the structure id which should be matched by the filter.- Returns:
- the structure id which should be matched by the filter
-
isIdFilter
Checks whether this is a filter which only filters by structure id.- Returns:
- true if this is a filter which only filters by structure id
-
isNameFilter
Checks whether this is a filter which only filters by name.- Returns:
- true if this is a filter which only filters by name
-
toString
-