org.terrier.structures.FieldDocumentIndexEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of terrier-core Show documentation
The newest version!
/*
 * Terrier - Terabyte Retriever 
 * Webpage: http://terrier.org/
 * Contact: terrier{a.}dcs.gla.ac.uk
 * University of Glasgow - School of Computing Science
 * http://www.gla.ac.uk/
 * 
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is FieldDocumentIndexEntry.java
 *
 * The Original Code is Copyright (C) 2004-2020 the University of Glasgow.
 * All Rights Reserved.
 *
 * Contributor(s):
 *   Craig Macdonald  (original contributor)
 */
package org.terrier.structures;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;

import org.terrier.utility.ArrayUtils;

/** A document index entry for use with fields */
public class FieldDocumentIndexEntry extends BasicDocumentIndexEntry {

	
	/** 
	 * Factory for creating a field document index entry 
	 */
	public static class Factory extends BasicDocumentIndexEntry.Factory
	{	
		protected int fieldCount;
		/**
		 * Constructs an instance of the class with
		 * @param _fieldCount
		 */
		public Factory(int _fieldCount)
		{
			super();
			this.fieldCount = _fieldCount;
		}
		/**
		 * Constructs an instance of the class with
		 * @param _fieldCount
		 */
		public Factory(String _fieldCount)
		{
			this(Integer.parseInt(_fieldCount));
		}

		@Override
		public int getSize() {
			return super.getSize() + fieldCount * 4;
		}

		@Override
		public DocumentIndexEntry newInstance() {
			return new FieldDocumentIndexEntry(fieldCount);
		}
		
	}
	
	protected int[] fieldLengths;
	
	//seldom used constructor
	/**
	 * Constructs an instance of the class.
	 */
	public FieldDocumentIndexEntry()
	{
		fieldLengths = new int[0];
	}
	/**
	 * Constructs an instance of the class with
	 * @param die
	 */
	public FieldDocumentIndexEntry(DocumentIndexEntry die)
	{
		super(die);
		if (die instanceof FieldDocumentIndexEntry)
			this.fieldLengths = ((FieldDocumentIndexEntry)die).getFieldLengths();
	}
	/**
	 * Constructs an instance of the class with
	 * @param fieldCount
	 */
	public FieldDocumentIndexEntry(int fieldCount) 
	{
		this.fieldLengths = new int[fieldCount];
	}
	/** 
	 * Get the lengths of each field
	 */
	public int[] getFieldLengths()
	{
		return this.fieldLengths;
	}
	/** 
	 * Set the lengths of each field
	 */
	public void setFieldLengths(int[] f_lens)
	{
		this.fieldLengths = f_lens;
	}
	
	@Override
	public void readFields(DataInput in) throws IOException {
		super.readFields(in);
		final int l = fieldLengths.length;
		for(int i=0;i