org.exist.util.ValueOccurrences Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of exist-core Show documentation
eXist-db NoSQL Database Core
There is a newer version: 6.3.0
/*
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * [email protected]
 * http://www.exist-db.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.exist.util;

import org.exist.dom.persistent.DefaultDocumentSet;
import org.exist.dom.persistent.DocumentImpl;
import org.exist.dom.persistent.MutableDocumentSet;
import org.exist.xquery.Constants;
import org.exist.xquery.XPathException;
import org.exist.xquery.value.AtomicValue;

/**
 * @author wolf
 *
 */
public class ValueOccurrences {

	private AtomicValue value;
	private int occurrences = 0;
	private MutableDocumentSet docs = new DefaultDocumentSet();

	public ValueOccurrences(AtomicValue value) {
		this.value = value;
	}

	public AtomicValue getValue() {
		return value;
	}
	
	/**
     * Returns the overall frequency of this term
     * in the document set.
	 *
	 * @return the occurrences
     */
	public int getOccurrences() {
		return occurrences;
	}

	public void addOccurrences(int count) {
		occurrences += count;
	}

    public void addDocument(DocumentImpl doc) {
        if(!docs.contains(doc.getDocId()))
            {docs.add(doc);}
    }
    
    public void add(ValueOccurrences other) {
    	addOccurrences(other.occurrences);
    	docs.addAll(other.docs);
    }
    
    /**
     * Returns the number of documents from the set in
     * which the term has been found.
	 *
	 * @return the number of documents
     */
    public int getDocuments() {
        return docs.getDocumentCount();
    }
    
	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Comparable#compareTo(java.lang.Object)
	 */
	public int compareTo(Object o) {
		try {
			return value.compareTo(null, ((ValueOccurrences) o).value);
		} catch (final XPathException e) {
			e.printStackTrace();
            //TODO : what does this mean ? -pb
			return Constants.INFERIOR;
		}
	}
	
	public String toString() {
		final StringBuilder buf = new StringBuilder();
		try {
			buf.append("Value: '").append(value.getStringValue()).append("'");
		} catch (final XPathException e) {
			buf.append("Value: '").append(e.getMessage()).append("'");
		}
		buf.append(" occurences: '").append(occurrences).append("'");
		buf.append(" documents: '").append(docs.getDocumentCount()).append("'");
		return buf.toString();
	}
}