framework.retrieval.engine.query.item.QuerySort.java Source code

Introduction

Here is the source code for framework.retrieval.engine.query.item.QuerySort.java

Source

/**
 * Copyright 2010 
 *
 * 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 framework.retrieval.engine.query.item;

import java.io.Serializable;

import org.apache.lucene.search.Sort;
import org.apache.lucene.search.SortField;

/**
 * ??
 * @author 
 *
 */
public class QuerySort implements Serializable {

    /**
     * 
     */
    private static final long serialVersionUID = 1704989704340181056L;

    private String fieldName;
    private boolean ascFlag = true;
    private int sortFieldType = SortField.STRING;
    private Sort sort;

    public QuerySort(Sort sort) {
        this.sort = sort;
    }

    /**
     * ??
     * @param fieldName   NULL,ID?
     * @param ascFlag ??
     */
    public QuerySort(String fieldName, boolean ascFlag) {
        this.fieldName = fieldName;
        this.ascFlag = ascFlag;
    }

    /**
     * ??
     * @param fieldName   NULL,ID?
     * @param sortFieldType   ?SortField????SortField.STRING
     * @param ascFlag ??
     */
    public QuerySort(String fieldName, int sortFieldType, boolean ascFlag) {
        this.fieldName = fieldName;
        this.ascFlag = ascFlag;
        this.sortFieldType = sortFieldType;
    }

    /**
     * ?Lucene?
     * @return
     */
    public Sort getSort() {
        if (sort != null) {
            return sort;
        } else {
            return new Sort(new SortField(fieldName, sortFieldType, ascFlag));
        }
    }

    public String toString() {
        return fieldName + "@" + ascFlag;
    }
}