java/dictionary-generator/src/cz/frantovo/telco/dictionary/IndexEntry.java
author František Kučera <franta-hg@frantovo.cz>
Mon, 22 Jun 2020 23:11:14 +0200
changeset 152 5c878a53d3ed
parent 151 a9f1ba451247
permissions -rw-r--r--
add dictionary and concept IDs + some documentation
franta-hg@15
     1
/**
franta-hg@15
     2
 * Free Telco Dictionary
franta-hg@15
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@15
     4
 *
franta-hg@15
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@15
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@151
     7
 * the Free Software Foundation, version 3 of the License.
franta-hg@15
     8
 *
franta-hg@15
     9
 * This program is distributed in the hope that it will be useful,
franta-hg@15
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@15
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@15
    12
 * GNU General Public License for more details.
franta-hg@15
    13
 *
franta-hg@15
    14
 * You should have received a copy of the GNU General Public License
franta-hg@15
    15
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@15
    16
 */
franta-hg@15
    17
package cz.frantovo.telco.dictionary;
franta-hg@15
    18
franta-hg@17
    19
import java.io.DataOutputStream;
franta-hg@17
    20
import java.io.IOException;
franta-hg@17
    21
import java.nio.charset.StandardCharsets;
franta-hg@17
    22
import java.util.Objects;
franta-hg@17
    23
franta-hg@15
    24
/**
franta-hg@130
    25
 * Represents one item in StarDict index file (.idx)
franta-hg@130
    26
 * which links the term and its position and length in data file (.dict)
franta-hg@130
    27
 * 
franta-hg@15
    28
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@15
    29
 */
franta-hg@15
    30
public class IndexEntry implements Comparable<IndexEntry> {
franta-hg@15
    31
franta-hg@17
    32
	private String name;
franta-hg@17
    33
	private long offset;
franta-hg@17
    34
	private long length;
franta-hg@17
    35
	private long ordinal;
franta-hg@17
    36
franta-hg@17
    37
	public IndexEntry(String name, long offset, long length) {
franta-hg@17
    38
		this.name = name;
franta-hg@17
    39
		this.offset = offset;
franta-hg@17
    40
		this.length = length;
franta-hg@17
    41
	}
franta-hg@17
    42
franta-hg@17
    43
	public void serialize(DataOutputStream indexOutputStream) throws IOException {
franta-hg@17
    44
		indexOutputStream.write(name.getBytes(StandardCharsets.UTF_8));
franta-hg@17
    45
		indexOutputStream.write(0);
franta-hg@17
    46
		indexOutputStream.writeInt((int) offset); // unsigned int 32
franta-hg@17
    47
		indexOutputStream.writeInt((int) length); // unsigned int 32
franta-hg@17
    48
	}
franta-hg@17
    49
franta-hg@17
    50
	public void setOrdinal(long ordinal) {
franta-hg@17
    51
		this.ordinal = ordinal;
franta-hg@17
    52
	}
franta-hg@17
    53
franta-hg@17
    54
	public long getOrdinal() {
franta-hg@17
    55
		return ordinal;
franta-hg@17
    56
	}
franta-hg@17
    57
franta-hg@15
    58
	@Override
franta-hg@15
    59
	public int compareTo(IndexEntry o) {
franta-hg@17
    60
		int nameDiff = name.compareTo(o.name);
franta-hg@17
    61
		if (nameDiff == 0) {
franta-hg@17
    62
			int offsetDiff = ((Long) offset).compareTo(o.offset);
franta-hg@17
    63
			if (offsetDiff == 0) {
franta-hg@17
    64
				return ((Long) length).compareTo(o.length);
franta-hg@17
    65
			} else {
franta-hg@17
    66
				return offsetDiff;
franta-hg@17
    67
			}
franta-hg@17
    68
		} else {
franta-hg@17
    69
			return nameDiff;
franta-hg@17
    70
		}
franta-hg@17
    71
	}
franta-hg@17
    72
franta-hg@17
    73
	@Override
franta-hg@17
    74
	public boolean equals(Object o) {
franta-hg@17
    75
		return o instanceof IndexEntry && compareTo((IndexEntry) o) == 0;
franta-hg@17
    76
	}
franta-hg@17
    77
franta-hg@17
    78
	@Override
franta-hg@17
    79
	public int hashCode() {
franta-hg@17
    80
		int hash = 5;
franta-hg@17
    81
		hash = 53 * hash + Objects.hashCode(this.name);
franta-hg@17
    82
		hash = 53 * hash + (int) (this.offset ^ (this.offset >>> 32));
franta-hg@17
    83
		hash = 53 * hash + (int) (this.length ^ (this.length >>> 32));
franta-hg@17
    84
		return hash;
franta-hg@15
    85
	}
franta-hg@15
    86
}