Package org.opencms.db.urlname
Class CmsUrlNameMappingFilter
- java.lang.Object
-
- org.opencms.db.urlname.CmsUrlNameMappingFilter
-
public class CmsUrlNameMappingFilter extends java.lang.Object
A class which contains filter criteria for reading or deleting URL name mapping entries.- Since:
- 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static CmsUrlNameMappingFilter
ALL
Base filter which matches all URL name mapping entries.
-
Constructor Summary
Constructors Modifier Constructor Description protected
CmsUrlNameMappingFilter()
The default constructor.protected
CmsUrlNameMappingFilter(CmsUrlNameMappingFilter filter)
The copy constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CmsUrlNameMappingFilter
filterLocale(java.lang.String locale)
Returns a new url name mapping filter based on the current one which also has to match a given locale.CmsUrlNameMappingFilter
filterName(java.lang.String name)
Creates a new filter from the current filter which also has to match a given name.CmsUrlNameMappingFilter
filterNamePattern(java.lang.String namePattern)
Creates a new filter from the current filter which also has to match a given name pattern.CmsUrlNameMappingFilter
filterRejectStructureId(CmsUUID id)
Creates a new filter from the current filter which also must not match a given structure id.CmsUrlNameMappingFilter
filterStates(int... states)
Creates a new filter from the current filter which also has to match a given state.CmsUrlNameMappingFilter
filterStructureId(CmsUUID structureId)
Creates a new filter from the current filter which also has to match a given structure id.java.lang.String
getLocale()
Returns the locale which should be matched by the filter.java.lang.String
getName()
Returns the name which should be matched by the filter.java.lang.String
getNamePattern()
Returns the name pattern which should be matched by the filter.CmsUUID
getRejectStructureId()
Returns the structure id which should not be matched by the filter.int[]
getStates()
Returns the state which should be matched by the filter.CmsUUID
getStructureId()
Returns the structure id which should be matched by the filter.boolean
isIdFilter()
Checks whether this is a filter which only filters by structure id.boolean
isNameFilter()
Checks whether this is a filter which only filters by name.java.lang.String
toString()
-
-
-
Field Detail
-
ALL
public static final CmsUrlNameMappingFilter ALL
Base filter which matches all URL name mapping entries.
-
-
Constructor Detail
-
CmsUrlNameMappingFilter
protected CmsUrlNameMappingFilter()
The default constructor.
-
CmsUrlNameMappingFilter
protected CmsUrlNameMappingFilter(CmsUrlNameMappingFilter filter)
The copy constructor.- Parameters:
filter
- the filter to copy
-
-
Method Detail
-
filterLocale
public CmsUrlNameMappingFilter filterLocale(java.lang.String locale)
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
public CmsUrlNameMappingFilter filterName(java.lang.String name)
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
public CmsUrlNameMappingFilter filterNamePattern(java.lang.String namePattern)
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
public CmsUrlNameMappingFilter filterRejectStructureId(CmsUUID id)
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
public CmsUrlNameMappingFilter filterStates(int... states)
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
public CmsUrlNameMappingFilter filterStructureId(CmsUUID structureId)
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
public java.lang.String getLocale()
Returns the locale which should be matched by the filter.- Returns:
- the locale
-
getName
public java.lang.String getName()
Returns the name which should be matched by the filter.- Returns:
- the name which should be matched by the filter
-
getNamePattern
public java.lang.String getNamePattern()
Returns the name pattern which should be matched by the filter.- Returns:
- the name pattern which should be matched by the filter
-
getRejectStructureId
public CmsUUID getRejectStructureId()
Returns the structure id which should not be matched by the filter.- Returns:
- a structure id
-
getStates
public int[] getStates()
Returns the state which should be matched by the filter.- Returns:
- the state which should be matched by the filter
-
getStructureId
public CmsUUID getStructureId()
Returns the structure id which should be matched by the filter.- Returns:
- the structure id which should be matched by the filter
-
isIdFilter
public boolean 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
public boolean 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
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
-