001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.db;
029
030import org.opencms.util.CmsUUID;
031
032/**
033 * This class is used for filtering aliases in database operations.<p>
034 */
035public class CmsAliasFilter {
036
037    /** The alias path. */
038    private String m_path;
039
040    /** The alias site root. */
041    private String m_siteRoot;
042
043    /** The alias structure id. */
044    private CmsUUID m_structureId;
045
046    /**
047     * Creates a new alias filter.<p>
048     *
049     * Any parameter which is null will not be used for filtering.<p>
050     *
051     * @param siteRoot the site root to filter
052     * @param aliasPath the alias path to filter
053     * @param structureId the structure id to filter
054     */
055    public CmsAliasFilter(String siteRoot, String aliasPath, CmsUUID structureId) {
056
057        m_path = aliasPath;
058        m_structureId = structureId;
059        m_siteRoot = siteRoot;
060    }
061
062    /**
063     * Gets the alias path to filter.<p>
064     *
065     * @return the alias path
066     */
067    public String getPath() {
068
069        return m_path;
070    }
071
072    /**
073     * Gets the site root to filter.<p>
074     *
075     * @return the site root
076     */
077    public String getSiteRoot() {
078
079        return m_siteRoot;
080    }
081
082    /**
083     * Gets the structure id to filter.<p>
084     *
085     * @return the structure id
086     */
087    public CmsUUID getStructureId() {
088
089        return m_structureId;
090    }
091
092    /**
093     * Checks whether this filter is trivial, i.e. would match all aliases.<p>
094     *
095     * @return true if the filter is trivial
096     */
097    public boolean isNullFilter() {
098
099        return (m_path == null) && (m_siteRoot == null) && (m_structureId == null);
100    }
101
102}