GlobPathMatchInfoGroup.java

/**
 * JHOVE2 - Next-generation architecture for format-aware characterization
 *
 * Copyright (c) 2009 by The Regents of the University of California,
 * Ithaka Harbors, Inc., and The Board of Trustees of the Leland Stanford
 * Junior University.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * o Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * o Neither the name of the University of California/California Digital
 *   Library, Ithaka Harbors/Portico, or Stanford University, nor the names of
 *   its contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package org.jhove2.module.aggrefy;

import java.util.ArrayList;
import java.util.List;

/**
 * Convenience class for managing information about a group of possibly 
 * related sources.  Used by {@org.jhove2.GlobPathRecognizer}
 * 
 * @author smmorrissey
 *
 */
public class GlobPathMatchInfoGroup {
	
	protected List<GlobPathMatchInfo> sourceMatchInfoList;
	/** count of sources that match the mustHave token */
	protected int mustHaveCount;
	/** count of sources that match the mayHave token */
	protected int mayHaveCount;
	/** count of sources that match neither mustHave nor mayHave token */
	protected int unmatchedCount;
	/** key that all sources in group match */
	protected String groupKey;
	
	/**
	 * Constructor
	 */
	public GlobPathMatchInfoGroup (){
		this.sourceMatchInfoList = new ArrayList<GlobPathMatchInfo>();
		this.mayHaveCount = 0;
		this.mustHaveCount = 0;
		this.unmatchedCount = 0;
	}
	/**
	 * Get the sourceMatchInfoList
	 * @return sourceMatchInfoList
	 */
	public List<GlobPathMatchInfo> getSourceMatchInfoList() {
		return sourceMatchInfoList;
	}
	/**
	 * Set the sourceMatchInfoList
	 * @param sourceMatchInfoList
	 */
	public void setSourceMatchInfoList(List<GlobPathMatchInfo> sourceMatchInfoList) {
		this.sourceMatchInfoList = sourceMatchInfoList;
	}
	/**
	 * Get the count of sources that match the mustHave token
	 * @return count of sources that match the mustHave token
	 */
	public int getMustHaveCount() {
		return mustHaveCount;
	}
	/**
	 * Set the count of sources that match the mustHave token
	 * @param count of sources that match the mustHave token
	 */
	public void setMustHaveCount(int mustHaveCount) {
		this.mustHaveCount = mustHaveCount;
	}
	/**
	 * get the count of sources that match the mayHave token 
	 * @return count of sources that match the mayHave token 
	 */
	public int getMayHaveCount() {
		return mayHaveCount;
	}
	/**
	 * Set the count of sources that match the mayHave token 
	 * @param count of sources that match the mayHave token 
	 */
	public void setMayHaveCount(int mayHaveCount) {
		this.mayHaveCount = mayHaveCount;
	}
	/**
	 * Get count of sources that match neither mustHave nor mayHave token
	 * @return
	 */
	public int getUnmatchedCount() {
		return unmatchedCount;
	}
	/**
	 * Set count of sources that match neither mustHave nor mayHave token
	 * @param unmatchedCount
	 */
	public void setUnmatchedCount(int unmatchedCount) {
		this.unmatchedCount = unmatchedCount;
	}
	/**
	 * Get key that all sources in group match
	 * @return
	 */
	public String getGroupKey() {
		return groupKey;
	}
	/**
	 * Set key that all sources in group match
	 * @param groupKey
	 */
	public void setGroupKey(String groupKey) {
		this.groupKey = groupKey;
	}
	
}