Package org.opencms.db

Class CmsAliasFilter

  • public class CmsAliasFilter
extends java.lang.Object
    This class is used for filtering aliases in database operations.

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsAliasFilter​(java.lang.String siteRoot, java.lang.String aliasPath, CmsUUID structureId)
      Creates a new alias filter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getPath()
      Gets the alias path to filter.
      java.lang.String getSiteRoot()
      Gets the site root to filter.
      CmsUUID getStructureId()
      Gets the structure id to filter.
      boolean isNullFilter()
      Checks whether this filter is trivial, i.e.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsAliasFilter

        public CmsAliasFilter​(java.lang.String siteRoot,
                      java.lang.String aliasPath,
                      CmsUUID structureId)
        Creates a new alias filter.

        Any parameter which is null will not be used for filtering.

        Parameters:
        siteRoot - the site root to filter
        aliasPath - the alias path to filter
        structureId - the structure id to filter

    • Method Detail

      • getPath

        public java.lang.String getPath()
        Gets the alias path to filter.

        Returns:
        the alias path

      • getSiteRoot

        public java.lang.String getSiteRoot()
        Gets the site root to filter.

        Returns:
        the site root

      • getStructureId

        public CmsUUID getStructureId()
        Gets the structure id to filter.

        Returns:
        the structure id

      • isNullFilter

        public boolean isNullFilter()
        Checks whether this filter is trivial, i.e. would match all aliases.

        Returns:
        true if the filter is trivial