alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/*
 * $Header: /cvsroot/mvnforum/mvnforum/src/com/mvnforum/search/member/MemberSearchQuery.java,v 1.3 2005/01/18 11:52:22 minhnn Exp $
 * $Author: minhnn $
 * $Revision: 1.3 $
 * $Date: 2005/01/18 11:52:22 $
 *
 * ====================================================================
 *
 * Copyright (C) 2002-2005 by MyVietnam.net
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or any later version.
 *
 * All copyright notices regarding mvnForum MUST remain intact
 * in the scripts and in the outputted HTML.
 * The "powered by" text/logo with a link back to
 * http://www.mvnForum.com and http://www.MyVietnam.net in the
 * footer of the pages MUST remain visible when the pages
 * are viewed on the internet or intranet.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Support can be obtained from support forums at:
 * http://www.mvnForum.com/mvnforum/index
 *
 * Correspondence and Marketing Questions can be sent to:
 * info@MyVietnam.net
 *
 * @author: Minh Nguyen  minhnn@MyVietnam.net
 * @author: Dejan Krsmanovic dejan_krsmanovic@yahoo.com
 */
package com.mvnforum.search.member;

import java.io.IOException;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Collection;

import com.mvnforum.MVNForumConfig;
import com.mvnforum.db.DAOFactory;
import com.mvnforum.db.MemberBean;
import net.myvietnam.mvncore.exception.DatabaseException;
import net.myvietnam.mvncore.exception.ObjectNotFoundException;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.queryParser.ParseException;
import org.apache.lucene.queryParser.QueryParser;
import org.apache.lucene.search.*;

/**
 * This class is used for specifying query that should be searched for. Query
 * can contain keywords and further it can be filtered by specifying member
 * name of the Member, address as well as date interval for searching.
 *
 * searchString contains one or more keywords. Each keyword can use wildcards.
 * ? for single character and * for multiple characters.
 * For specifying boolean operators AND and OR operators can be used.....
 *
 * For all available options consult Lucene documentation http://jakarta.apache.org/lucene
 *
 * @author Dejan Krsmanovic dejan_krsmanovic@yahoo.com
 */
public class MemberSearchQuery
{
    // search object constants
    public static final int SEARCH_ANY_DATE = 0;

    public static final int SEARCH_NEWER    = 1;
    public static final int SEARCH_OLDER    = 2;

    // search object properties
    private String memberEmailKey = null;
    private String memberNameKey = null;

    private String memberLastNameKey = null;
    private String memberFirstNameKey = null;
    //private String memberGender = null;
    private String memberCountry =  null;

    private Timestamp from = null;
    private Timestamp to = null;

    // search engine properties
    private static Log log = LogFactory.getLog(MemberSearchQuery.class);

    private String searchMemberIndexDir = null;
    private int hitCount = 0;
    private Collection searchResult = null;

    public MemberSearchQuery() {
        searchMemberIndexDir = MVNForumConfig.getSearchMemberIndexDir();
    }
    /**
     * Set string that should be searched for.
     * @param memberNameKey
     */
    public void setMemberNameKey(String memberNameKey) {
        this.memberNameKey = memberNameKey;
    }

    public void setMemberEmailKey(String memberEmailKey) {
        this.memberEmailKey = memberEmailKey;
    }

    public void setFromDate(Timestamp from) {
        this.from = from;
    }

    public void setToDate(Timestamp to) {
        this.to = to;
    }

    public void setMemberLastNameKey(String lastNameKey) {
        this.memberLastNameKey = lastNameKey;
    }

    public void setMemberFirstNameKey(String firstNameKey) {
        this.memberFirstNameKey = firstNameKey;
    }

    public void setCountry(String country) {
        this.memberCountry = country;
    }

    protected IndexSearcher getSearcher() throws IOException {
        try {
            IndexSearcher searcher = new IndexSearcher(searchMemberIndexDir);
            return searcher;
        } catch (IOException ex) {
            // we throw new IOException because the original exception
            // contain sensitive directory information
            log.error("Cannot access the lucene search index for query. Please check if you have configed mvnForumHome properly. You can also go to Admin Zone to rebuild the Lucene index files.", ex);
            throw new IOException("Cannot access the lucene search index. Please report this error to web site Administrator (check mvnForumHome or rebuild Lucene index).");
        }
    }

    public void searchDocuments(int offset, int rowsToReturn)
        throws IOException, DatabaseException, ObjectNotFoundException {
        //Build the query
        //Analyzer analyzer = MemberIndexer.getAnalyzer();
        BooleanQuery query = new BooleanQuery();//query.
        try {
            Query memberNameQuery = getMemberNameQuery();
            if (memberNameQuery != null) {
                query.add(memberNameQuery, true, false);
                log.debug("MemberNameQuery = " + memberNameQuery);
            }
            Query memberEmailQuery = getMemberEmailQuery();
            if (memberEmailQuery != null) {
                query.add(memberEmailQuery, true, false);
            }
            Query memberLastNameQuery = getMemberLastNameQuery();
            if (memberLastNameQuery != null) {
                query.add(memberLastNameQuery, true, false);
            }
            Query memberFirstNameQuery = getMemberFirstNameQuery();
            if (memberFirstNameQuery != null) {
                query.add(memberFirstNameQuery, true, false);
            }
            Query memberCountryQuery = getMemberCountryQuery();
            if (memberCountryQuery != null) {
                query.add(memberCountryQuery, true, false);
            }
        } catch (ParseException pe) {
            log.error("Cannot parse the search query", pe);
        }
        log.debug("[OK ] booleanQuery = " + query);

        DateFilter dateFilter = null;

        if (from != null && to != null) {
            dateFilter = new DateFilter(MemberIndexer.FIELD_CREATION_DATE, from, to);
        } else if (from != null) {
            dateFilter = DateFilter.After(MemberIndexer.FIELD_CREATION_DATE, from);
        } else if (to != null) {
            dateFilter = DateFilter.Before(MemberIndexer.FIELD_CREATION_DATE, to);
        }

        //Now search the documents
        IndexSearcher searcher = null;
        try {
            searcher = getSearcher();

            //If dateFilter set then use it
            Hits memberHits = null;
            //dateFilter = null;
            if (dateFilter != null) {
                memberHits = searcher.search(query, dateFilter);
            } else {
                memberHits = searcher.search(query);
            }
            hitCount = memberHits.length();
            log.debug("[ HIT COUNT ]"  + hitCount);
            searchResult = getMembers(memberHits, offset, rowsToReturn);
        } catch (IOException ex) {
            throw ex;
        } finally {
            try {
                if (searcher != null) {
                    searcher.close();
                }
            } catch (Exception ex) {}
        }
    }

    public int getHitCount() {
        return hitCount;
    }

    public Collection getMemberResult() {
        return searchResult;
    }

    private Collection getMembers(Hits MemberHits, int offset, int rowsToReturn)
        throws IOException, ObjectNotFoundException, DatabaseException {

        if (offset < 0) throw new IllegalArgumentException("The offset < 0 is not allowed.");
        if (rowsToReturn <= 0) throw new IllegalArgumentException("The rowsToReturn <= 0 is not allowed.");

        //int hitCount = getHitCount();
        ArrayList retValue = new ArrayList(hitCount);

        for (int i = offset; (i < offset + rowsToReturn) && (i < hitCount); i++) {
            Document memberDocument = MemberHits.doc(i);
            int memberID = Integer.parseInt(memberDocument.get(MemberIndexer.FIELD_MEMBER_ID));
            MemberBean MemberBean = DAOFactory.getMemberDAO().getMember_forPublic(memberID);
            retValue.add(MemberBean);
        }
        return retValue;
    }

    private Query getMemberNameQuery() throws ParseException {
        if (memberNameKey == null) {
            return null;
        }
        Analyzer analyzer = MemberIndexer.getAnalyzer();
        Query memberNameQuery = QueryParser.parse(memberNameKey,
                                                   MemberIndexer.FIELD_MEMBER_NAME,
                                                   analyzer);
        return memberNameQuery;
    }

    private Query getMemberEmailQuery() throws ParseException {
        if (memberEmailKey == null) {
            return null;
        }
        Analyzer analyzer = MemberIndexer.getAnalyzer();
        Query memberEmailQuery = QueryParser.parse(memberEmailKey,
                                                   MemberIndexer.FIELD_MEMBER_EMAIL,
                                                   analyzer);
        return memberEmailQuery;
    }

    private Query getMemberQuery(String fieldName, String keyQuery) throws ParseException {
        if (keyQuery == null ) {
            return null;
        }
        Analyzer analyzer = MemberIndexer.getAnalyzer();
        Query memberQuery = QueryParser.parse(keyQuery, fieldName, analyzer);
        return memberQuery;
    }

    private Query getMemberLastNameQuery() throws ParseException {
        return getMemberQuery (MemberIndexer.FIELD_MEMBER_LASTNAME,
                               memberLastNameKey);
    }
    private Query getMemberFirstNameQuery() throws ParseException {
        return getMemberQuery (MemberIndexer.FIELD_MEMBER_FIRSTNAME,
                               memberFirstNameKey);
    }

    private Query getMemberCountryQuery() throws ParseException {
        return getMemberQuery (MemberIndexer.FIELD_MEMBER_COUNTRY,
                               memberCountry);
    }
}
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.