/*
 *  Copyright 2010 Anyware Services
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.ametys.web.filter;

import java.util.List;
import java.util.Map;

import org.ametys.plugins.repository.AmetysObjectIterable;
import org.ametys.plugins.repository.AmetysObjectResolver;
import org.ametys.plugins.repository.query.SortCriteria;
import org.ametys.runtime.i18n.I18nizableText;
import org.ametys.web.repository.page.Page;

/**
 * This interface represents a filter for {@link Page}
 */
public interface PageFilter
{
    /** 
     * The search context 
     */
    public enum Context 
    {
        /** Constant to search only on current site */
        CURRENT_SITE
        {
            @Override
            public String toString()
            {
                return "current-site";
            }
        },
        /** Constant to search in all sites */
        SITES
        {
            @Override
            public String toString()
            {
                return "all-sites";
            }
        },
        /** Constant to search in other sites */
        OTHER_SITES
        {
            @Override
            public String toString()
            {
                return "other-sites";
            }
        },
        /** Constant to search in child pages */
        CHILD_PAGES
        {
            @Override
            public String toString()
            {
                return "child-pages";
            }
        }
    }
    
    /**
     * The context language
     */
    public enum ContextLanguage 
    {
        /** Constant to search only in the current sitemap */
        CURRENT
        {
            @Override
            public String toString ()
            {
                return "current";
            }
        },
        /** Constant to search in all sitemap */
        ALL
        {
            @Override
            public String toString ()
            {
                return "all";
            }
        },
        /** Constant to search in other sitemaps */
        OTHERS
        {
            @Override
            public String toString ()
            {
                return "others";
            }
        }
    }
    
    /**
     * Get the filter id
     * @return The filter id
     */
    public String getId ();
    
    /**
     * Set the filter id.
     * @param id The id to set.
     */
    public void setId (String id);
    
    /**
     * Get the metadata id and value to match
     * @return The metadata to match pages
     */
    public Map<String, String> getMetadataValues ();
    
    /**
     * Add a metadata filter
     * @param metadataId The metadata id.
     * @param value The value to test. Set null to test existence
     */
    public void addMetadata (String metadataId, String value);
    
    /**
     * Get the tag keys to match pages
     * @return The tag keys to match pages
     */
    public List<String> getTags ();
    
    /**
     * Add a tag to the filter
     * @param tag The tag key to add
     */
    public void addTag (String tag);
    
    /**
     * Get the search context
     * @return The search context
     */
    public Context getContext ();
    
    /**
     * Set the search context
     * @param context The search context to set
     */
    public void setContext (Context context);
    
    /**
     * Get the context language
     * @return The context language
     */
    public ContextLanguage getContextLanguage ();
    
    /**
     * Set the context language
     * @param contextLang The context language
     */
    public void setContextLanguage (ContextLanguage contextLang);
    
    /**
     * Get the search depth
     * @return The search depth
     */
    public int getDepth ();

    /**
     * Set the search depth 
     * @param depth The search depth. Set to <code>0</code> for no depth limitation.
     */
    public void setDepth (int depth);
    
    /**
     * Get the max number of results
     * @return The max number of results
     */
    public int getLength ();
    
    /**
     * Set the max number o results
     * @param length The max number of results
     */
    public void setLength (int length);
    
    /**
     * Get the sort criteria allows to sort query results.
     * @return the sort criteria
     */
    public SortCriteria getSortCriteria ();
    
    /**
     * Get the parent page id
     * @return The parent page id
     */
    public String getPageId();

    /**
     * set the parent page Id.
     * @param pageId Id of the parent page (when fetching child of a page).
     */
    public void setPageId(String pageId);

    /**
     * Add a sort criteria
     * @param metadataId The metadata id to sort
     * @param ascending true to ascending sort
     * @param useLowerCase <code>true</code> for case insensitive order on a string property
     */
    public void addSortCriteria (String metadataId, boolean ascending, boolean useLowerCase);
    
    /**
     * Set the ametys object resolver to execute query
     * @param resolver The ametys object resolver to set
     */
    public void setResolver (AmetysObjectResolver resolver);
    
    /**
     * Get the pages matching this filter.
     * @param siteName The current site name.
     * @param lang The current language. Can be null.
     * @param page The current page.
     * @return The matching pages.
     */
    public AmetysObjectIterable<Page> getMatchingPages (String siteName, String lang, Page page);

    /**
     * Get the title
     * @return The title
     */
    public I18nizableText getTitle ();

    /**
     * Set the title
     * @param title The title
     */
    public void setTitle (I18nizableText title);
}