001/*
002 *  Copyright 2015 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.web.search.query;
017
018import org.ametys.cms.search.query.Query;
019import org.ametys.cms.search.query.QuerySyntaxException;
020import org.ametys.web.indexing.solr.SolrWebFieldNames;
021
022/**
023 * Represents a {@link Query} testing the orphan status of a content.
024 */
025public class OrphanQuery implements Query
026{
027    
028    private boolean _orphan;
029    
030    /**
031     * Create an OrphanQuery.
032     * @param orphan <code>true</code> to get only orphan contents,
033     * <code>false</code> to get only non-orphan contents.
034     */
035    public OrphanQuery(boolean orphan)
036    {
037        this._orphan = orphan;
038    }
039    
040    @Override
041    public String build() throws QuerySyntaxException
042    {
043        return SolrWebFieldNames.ORPHAN + ":" + (_orphan ? "true" : "false");
044    }
045
046    @Override
047    public int hashCode()
048    {
049        final int prime = 31;
050        int result = 1;
051        result = prime * result + (_orphan ? 1231 : 1237);
052        return result;
053    }
054
055    @Override
056    public boolean equals(Object obj)
057    {
058        if (this == obj)
059        {
060            return true;
061        }
062        if (obj == null)
063        {
064            return false;
065        }
066        if (getClass() != obj.getClass())
067        {
068            return false;
069        }
070        OrphanQuery other = (OrphanQuery) obj;
071        if (_orphan != other._orphan)
072        {
073            return false;
074        }
075        return true;
076    }
077}