// Row.java
// (C) 2006 by Michael Peter Christen; mc@yacy.net, Frankfurt a. M., Germany
// first published 24.05.2006 on http://www.anomic.de
//
// This is a part of the kelondro database,
// which is a part of YaCy, a peer-to-peer based web search engine
//
// $LastChangedDate: 2011-05-18 16:26:28 +0200 (Mi, 18. Mai 2011) $
// $LastChangedRevision: 7729 $
// $LastChangedBy: orbiter $
//
// LICENSE
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package net.yacy.kelondro.index;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.Iterator;
import java.util.Map;
import java.util.StringTokenizer;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.ConcurrentHashMap;
import java.util.regex.Pattern;
import net.yacy.cora.document.UTF8;
import net.yacy.kelondro.logging.Log;
import net.yacy.kelondro.order.AbstractOrder;
import net.yacy.kelondro.order.Base64Order;
import net.yacy.kelondro.order.Bitfield;
import net.yacy.kelondro.order.ByteOrder;
import net.yacy.kelondro.order.NaturalOrder;
import net.yacy.kelondro.order.Order;
import net.yacy.kelondro.util.ByteBuffer;
import net.yacy.kelondro.util.kelondroException;
public final class Row {
private final static Pattern commaPattern = Pattern.compile(",");
protected final Column[] row;
public final int[] colstart;
public final ByteOrder objectOrder;
public final int objectsize;
public final int primaryKeyLength;
protected Map<String, Object[]> nickref = null; // a mapping from nicknames to Object[2]{kelondroColumn, Integer(colstart)}
public Row(final Column[] row, final ByteOrder objectOrder) {
assert objectOrder != null;
this.objectOrder = objectOrder;
this.row = row;
assert (objectOrder != null);
this.colstart = new int[row.length];
int os = 0;
for (int i = 0; i < row.length; i++) {
this.colstart[i] = os;
os+= this.row[i].cellwidth;
}
this.objectsize = os;
this.primaryKeyLength = this.row[0].cellwidth;
}
public Row(final String structure, final ByteOrder objectOrder) {
assert (objectOrder != null);
this.objectOrder = objectOrder;
// define row with row syntax
// example:
//# Structure=<pivot-12>,<UDate-3>,<VDate-3>,<LCount-2>,<GCount-2>,<ICount-2>,<DCount-2>,<TLength-3>,<WACount-3>,<WUCount-3>,<Flags-1>
// parse pivot definition:
//does not work with 'String idx-26 "id = created + originator",String cat-8,String rec-14,short dis-2 {b64e},String att-462'
//structure = structure.replace('=', ',');
// parse property part definition:
int p = structure.indexOf('|');
if (p < 0) p = structure.length();
final ArrayList<Column> l = new ArrayList<Column>();
final String attr = structure.substring(0, p);
final StringTokenizer st = new StringTokenizer(attr, ",");
while (st.hasMoreTokens()) {
l.add(new Column(st.nextToken()));
}
// define columns
this.row = new Column[l.size()];
this.colstart = new int[row.length];
int os = 0;
for (int i = 0; i < l.size(); i++) {
this.colstart[i] = os;
this.row[i] = l.get(i);
os += this.row[i].cellwidth;
}
this.objectsize = os;
this.primaryKeyLength = this.row[0].cellwidth;
}
public final ByteOrder getOrdering() {
return this.objectOrder;
}
protected final void genNickRef() {
if (nickref != null) return;
nickref = new ConcurrentHashMap<String, Object[]>(row.length);
for (int i = 0; i < row.length; i++) nickref.put(row[i].nickname, new Object[]{row[i], Integer.valueOf(colstart[i])});
}
public final int columns() {
return this.row.length;
}
public final Column column(final int col) {
return row[col];
}
public final int width(final int column) {
return this.row[column].cellwidth;
}
public final int[] widths() {
final int[] w = new int[this.row.length];
for (int i = 0; i < this.row.length; i++) w[i] = row[i].cellwidth;
return w;
}
@Override
public final String toString() {
final StringBuilder s = new StringBuilder(80);
s.append(row[0].toString());
for (int i = 1; i < row.length; i++) {
s.append(", ");
s.append(row[i].toString());
}
return s.toString();
}
public final Entry newEntry() {
return new Entry();
}
public final Entry newEntry(final byte[] rowinstance) {
if (rowinstance == null) return null;
//assert (rowinstance[0] != 0);
if (!(this.objectOrder.wellformed(rowinstance, 0, this.primaryKeyLength))) {
Log.logWarning("kelondroRow", "row not well-formed: rowinstance[0] = " + UTF8.String(rowinstance, 0, this.primaryKeyLength) + " / " + NaturalOrder.arrayList(rowinstance, 0, this.primaryKeyLength));
return null;
}
return new Entry(rowinstance, false);
}
public final Entry newEntry(final Entry oldrow, final int fromColumn) {
if (oldrow == null) return null;
assert (oldrow.getColBytes(0, false)[0] != 0);
assert (this.objectOrder.wellformed(oldrow.getPrimaryKeyBytes(), 0, this.primaryKeyLength));
return new Entry(oldrow, fromColumn, false);
}
public final Entry newEntry(final byte[] rowinstance, final int start, final boolean clone) {
if (rowinstance == null) return null;
//assert (rowinstance[0] != 0);
assert (this.objectOrder.wellformed(rowinstance, start, this.primaryKeyLength)) : "rowinstance = " + UTF8.String(rowinstance);
// this method offers the option to clone the content
// this is necessary if it is known that the underlying byte array may change and therefore
// the reference to the byte array does not contain the original content
return new Entry(rowinstance, start, clone);
}
public final Entry newEntry(final byte[][] cells) {
if (cells == null) return null;
assert (cells[0][0] != 0);
assert (this.objectOrder.wellformed(cells[0], 0, this.primaryKeyLength));
return new Entry(cells);
}
public final Entry newEntry(final String external, final boolean decimalCardinal) {
if (external == null) return null;
return new Entry(external, decimalCardinal);
}
public final EntryIndex newEntryIndex(final byte[] rowinstance, final int index) {
if (rowinstance == null) return null;
assert (rowinstance[0] != 0);
assert (this.objectOrder.wellformed(rowinstance, 0, this.primaryKeyLength));
return new EntryIndex(rowinstance, index);
}
public static class EntryComparator extends AbstractOrder<Entry> implements Order<Entry>, Comparator<Entry>, Cloneable {
ByteOrder base;
public EntryComparator(final ByteOrder baseOrder) {
this.base = baseOrder;
}
public int compare(final Entry a, final Entry b) {
return a.compareTo(b);
}
public boolean equal(final Entry a, final Entry b) {
return a.equals(b);
}
public Order<Entry> clone() {
return new EntryComparator(base);
}
public long cardinal(final Entry key) {
return base.cardinal(key.bytes(), 0, key.getPrimaryKeyLength());
}
public String signature() {
return base.signature();
}
public boolean wellformed(final Entry a) {
return base.wellformed(a.getPrimaryKeyBytes());
}
}
public class Entry implements Comparable<Entry>, Comparator<Entry> {
private byte[] rowinstance;
private int offset; // the offset where the row starts within rowinstance
public Entry() {
rowinstance = new byte[objectsize];
//for (int i = 0; i < objectsize; i++) this.rowinstance[i] = 0;
offset = 0;
}
public Entry(final byte[] newrow, final boolean forceclone) {
this(newrow, 0, forceclone);
}
public Entry(final Entry oldrow, final int fromColumn, final boolean forceclone) {
this(oldrow.rowinstance, oldrow.offset + oldrow.colstart(fromColumn), forceclone);
}
public Entry(final byte[] newrow, final int start, final boolean forceclone) {
if ((!forceclone) && (newrow.length - start >= objectsize)) {
this.rowinstance = newrow;
this.offset = start;
} else {
this.rowinstance = new byte[objectsize];
System.arraycopy(newrow, start, this.rowinstance, 0, objectsize);
this.offset = 0;
}
//for (int i = ll; i < objectsize; i++) this.rowinstance[i] = 0;
}
public Entry(final byte[][] cols) {
assert row.length == cols.length : "cols.length = " + cols.length + ", row.length = " + row.length;
this.rowinstance = new byte[objectsize];
this.offset = 0;
int ll;
int cs, cw;
for (int i = 0; i < row.length; i++) {
cs = colstart[i];
cw = row[i].cellwidth;
if ((i >= cols.length) || (cols[i] == null)) {
for (int j = 0; j < cw; j++) this.rowinstance[cs + j] = 0;
} else {
//assert cols[i].length <= cw : "i = " + i + ", cols[i].length = " + cols[i].length + ", cw = " + cw;
ll = Math.min(cols[i].length, cw);
System.arraycopy(cols[i], 0, rowinstance, cs, ll);
for (int j = ll; j < cw; j++) this.rowinstance[cs + j] = 0;
}
}
}
public Entry(String external, final boolean decimalCardinal) {
// parse external form
if (external.length() > 0 && external.charAt(0) == '{') external = external.substring(1, external.length() - 1);
final String[] elts = commaPattern.split(external);
if (nickref == null) genNickRef();
String nick;
int p;
this.rowinstance = new byte[objectsize];
this.offset = 0;
for (int i = 0; i < elts.length; i++) {
p = elts[i].indexOf('=');
if (p < 0) p = elts[i].indexOf(':');
if (p > 0) {
nick = elts[i].substring(0, p).trim();
if (nick.charAt(0) == '"' && nick.charAt(nick.length() - 1) == '"') nick = nick.substring(1, nick.length() - 1);
final Object[] ref = nickref.get(nick);
Column col = (Column) ref[0];
int clstrt = ((Integer) ref[1]).intValue();
if (p + 1 == elts[i].length()) {
setCol(clstrt, col.cellwidth, null);
} else {
if ((decimalCardinal) && (col.celltype == Column.celltype_cardinal)) {
try {
setCol(col.encoder, offset + clstrt, col.cellwidth, Long.parseLong(elts[i].substring(p + 1).trim()));
} catch (final NumberFormatException e) {
Log.logSevere("kelondroRow", "NumberFormatException for celltype_cardinal; row = " + i + ", celltype = " + col.celltype + ", encoder = " + col.encoder + ", value = '" + elts[i].substring(p + 1).trim() + "'");
setCol(col.encoder, offset + clstrt, col.cellwidth, 0);
}
} else if ((decimalCardinal) && (col.celltype == Column.celltype_binary)) {
assert col.cellwidth == 1;
try {
setCol(clstrt, col.cellwidth, new byte[]{(byte) Integer.parseInt(elts[i].substring(p + 1).trim())});
} catch (final NumberFormatException e) {
Log.logSevere("kelondroRow", "NumberFormatException for celltype_binary; row = " + i + ", celltype = " + col.celltype + ", encoder = " + col.encoder + ", value = '" + elts[i].substring(p + 1).trim() + "'");
setCol(clstrt, col.cellwidth, new byte[]{0});
}
} else if ((decimalCardinal) && (col.celltype == Column.celltype_bitfield)) {
setCol(clstrt, col.cellwidth, (new Bitfield(col.cellwidth, elts[i].substring(p + 1).trim())).bytes());
} else {
setCol(clstrt, col.cellwidth, UTF8.getBytes(elts[i].substring(p + 1).trim()));
}
}
}
}
}
protected final int colstart(final int column) {
return colstart[column];
}
protected final int cellwidth(final int column) {
return row[column].cellwidth;
}
public final int compareTo(final Entry o) {
// compares only the content of the primary key
if (objectOrder == null) throw new kelondroException("objects cannot be compared, no order given");
assert primaryKeyLength == o.getPrimaryKeyLength();
return objectOrder.compare(this.bytes(), 0, o.bytes(), 0, primaryKeyLength);
}
public int compare(final Entry o1, final Entry o2) {
return o1.compareTo(o2);
}
// compare the content of the primary key
@Override
public boolean equals(final Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (!(obj instanceof Entry)) return false;
final Entry other = (Entry) obj;
final byte[] t = this.bytes();
final byte[] o = other.bytes();
for (int i = 0; i < primaryKeyLength; i++) {
if (t[i] != o[i]) return false;
}
return true;
}
@Override
public int hashCode() {
final byte[] b = this.getPrimaryKeyBytes();
final int len = b.length;
int h = 1;
for (int i = 0; i < len; i++) {
h = 31 * h + b[i];
}
return h;
}
public final byte[] bytes() {
if ((offset == 0) && (rowinstance.length == objectsize)) {
return rowinstance;
}
final byte[] tmp = new byte[objectsize];
System.arraycopy(rowinstance, offset, tmp, 0, objectsize);
return tmp;
}
public final void writeToArray(final byte[] target, final int targetOffset) {
// this method shall replace the byte()s where possible, bacause it may reduce the number of new byte[] allocations
assert (targetOffset + objectsize <= target.length) : "targetOffset = " + targetOffset + ", target.length = " + target.length + ", objectsize = " + objectsize;
System.arraycopy(rowinstance, offset, target, targetOffset, objectsize);
}
public final int columns() {
return row.length;
}
public final int objectsize() {
return objectsize;
}
public final boolean empty(final int column) {
return rowinstance[offset + colstart[column]] == 0;
}
public final void setCol(final int column, final byte[] cell) {
setCol(colstart[column], row[column].cellwidth, cell);
}
public final void setCol(final int column, final char[] cell) {
final int clstrt = colstart[column];
for (int i = 0; i < cell.length; i++) rowinstance[offset + clstrt + i] = (byte) cell[i];
for (int i = cell.length; i < row[column].cellwidth; i++) rowinstance[offset + clstrt + i] = 0;
}
private final void setCol(final int clstrt, int length, final byte[] cell) {
if (cell == null) {
while (length-- > 0) rowinstance[offset + clstrt + length] = 0;
} else {
if (cell.length < length) {
System.arraycopy(cell, 0, rowinstance, offset + clstrt, cell.length);
while (length-- > cell.length) rowinstance[offset + clstrt + length] = 0;
} else {
//assert cell.length == length;
System.arraycopy(cell, 0, rowinstance, offset + clstrt, length);
}
}
}
public final void setCol(final int column, final byte c) {
rowinstance[offset + colstart[column]] = c;
}
public final void setCol(final int column, final String cell) {
setCol(column, UTF8.getBytes(cell));
}
public final void setCol(final int column, final long cell) {
// uses the column definition to choose the right encoding
setCol(row[column].encoder, offset + colstart[column], row[column].cellwidth, cell);
}
private final void setCol(final int encoder, final int offset, final int length, final long cell) {
switch (encoder) {
case Column.encoder_none:
throw new kelondroException("ROW", "setColLong has celltype none, no encoder given");
case Column.encoder_b64e:
Base64Order.enhancedCoder.encodeLong(cell, rowinstance, offset, length);
break;
case Column.encoder_b256:
NaturalOrder.encodeLong(cell, rowinstance, offset, length);
break;
case Column.encoder_bytes:
throw new kelondroException("ROW", "setColLong of celltype bytes not applicable");
}
}
public final long incCol(final int column, final long c) {
final int encoder = row[column].encoder;
final int colstrt = colstart[column];
final int cellwidth = row[column].cellwidth;
long l;
switch (encoder) {
case Column.encoder_b64e:
l = c + Base64Order.enhancedCoder.decodeLong(rowinstance, offset + colstrt, cellwidth);
Base64Order.enhancedCoder.encodeLong(l, rowinstance, offset + colstrt, cellwidth);
return l;
case Column.encoder_b256:
l = c + NaturalOrder.decodeLong(rowinstance, offset + colstrt, cellwidth);
NaturalOrder.encodeLong(l, rowinstance, offset + colstrt, cellwidth);
return l;
}
throw new kelondroException("ROW", "addCol did not find appropriate encoding");
}
public final String getColString(final int column) {
final int clstrt = colstart[column];
int length = row[column].cellwidth;
if (rowinstance[offset + clstrt] == 0) return null;
assert length <= rowinstance.length - offset - clstrt;
if (length > rowinstance.length - offset - clstrt) length = rowinstance.length - offset - clstrt;
while ((length > 0) && (rowinstance[offset + clstrt + length - 1] == 0)) length--;
if (length == 0) return null;
return UTF8.String(rowinstance, offset + clstrt, length);
}
public final long getColLong(final int column) {
// uses the column definition to choose the right encoding
return getColLong(row[column].encoder, colstart[column], row[column].cellwidth);
}
protected final long getColLong(final int encoder, final int clstrt, final int length) {
switch (encoder) {
case Column.encoder_none:
throw new kelondroException("ROW", "getColLong has celltype none, no encoder given");
case Column.encoder_b64e:
// start - fix for badly stored parameters
if ((length >= 3) && (rowinstance[offset + clstrt] == '[') && (rowinstance[offset + clstrt + 1] == 'B') && (rowinstance[offset + clstrt + 2] == '@')) return 0;
if ((length == 2) && (rowinstance[offset + clstrt] == '[') && (rowinstance[offset + clstrt + 1] == 'B')) return 0;
if ((length == 1) && (rowinstance[offset + clstrt] == '[')) return 0;
boolean maxvalue = true;
for (int i = 0; i < length; i++) if (rowinstance[offset + clstrt + i] != '_') {maxvalue = false; break;}
if (maxvalue) return 0;
// stop - fix for badly stored parameters
return Base64Order.enhancedCoder.decodeLong(rowinstance, offset + clstrt, length);
case Column.encoder_b256:
return NaturalOrder.decodeLong(rowinstance, offset + clstrt, length);
case Column.encoder_bytes:
throw new kelondroException("ROW", "getColLong of celltype bytes not applicable");
}
throw new kelondroException("ROW", "getColLong did not find appropriate encoding");
}
public final byte getColByte(final int column) {
return rowinstance[offset + colstart[column]];
}
public final byte[] getPrimaryKeyBytes() {
final byte[] c = new byte[primaryKeyLength];
System.arraycopy(rowinstance, offset, c, 0, primaryKeyLength);
return c;
}
public final int getPrimaryKeyLength() {
return primaryKeyLength;
}
public final byte[] getColBytes(final int column, boolean nullIfEmpty) {
assert offset + colstart[column] + row[column].cellwidth <= rowinstance.length :
"column = " + column + ", offset = " + offset + ", colstart[column] = " + colstart[column] + ", row[column].cellwidth() = " + row[column].cellwidth + ", rowinstance.length = " + rowinstance.length;
int clstrt = colstart[column];
final int w = row[column].cellwidth;
if (nullIfEmpty) {
int length = w;
while (length > 0 && rowinstance[offset + clstrt + length - 1] == 0) length--;
if (length == 0) return null;
}
final byte[] c = new byte[w];
System.arraycopy(rowinstance, offset + clstrt, c, 0, w);
return c;
}
public final void writeToArray(final int column, final byte[] target, final int targetOffset) {
// this method shall replace the getColBytes where possible, bacause it may reduce the number of new byte[] allocations
assert (targetOffset + row[column].cellwidth <= target.length) : "targetOffset = " + targetOffset + ", target.length = " + target.length + ", row[column].cellwidth() = " + row[column].cellwidth;
System.arraycopy(rowinstance, offset + colstart[column], target, targetOffset, row[column].cellwidth);
}
public final String toPropertyForm(final char propertySymbol, final boolean includeBraces, final boolean decimalCardinal, final boolean longname, final boolean quotes) {
final ByteBuffer bb = new ByteBuffer(objectsize() * 2);
if (includeBraces) bb.append('{');
for (int i = 0; i < row.length; i++) {
if (quotes) bb.append('"');
bb.append((longname) ? row[i].description : row[i].nickname);
if (quotes) bb.append('"');
bb.append(propertySymbol);
if (quotes) bb.append('"');
if ((decimalCardinal) && (row[i].celltype == Column.celltype_cardinal)) {
bb.append(Long.toString(getColLong(i)));
} else if ((decimalCardinal) && (row[i].celltype == Column.celltype_bitfield)) {
bb.append((new Bitfield(getColBytes(i, true))).exportB64());
} else if ((decimalCardinal) && (row[i].celltype == Column.celltype_binary)) {
assert row[i].cellwidth == 1 : toString();
bb.append(Integer.toString((0xff & getColByte(i))));
} else {
bb.append(rowinstance, offset + colstart[i], row[i].cellwidth);
}
if (quotes) bb.append('"');
if (i < row.length - 1) {
bb.append(',');
if (longname) bb.append(' ');
}
}
if (includeBraces) bb.append('}');
//System.out.println("DEBUG-ROW " + bb.toString());
return bb.toString();
}
@Override
public final String toString() {
return toPropertyForm('=', true, false, false, false);
}
}
public final class EntryIndex extends Entry {
private final int index;
public EntryIndex(final byte[] row, final int i) {
super(row, false);
this.index = i;
}
public int index() {
return index;
}
}
public Queue newQueue(final int maxsize) {
return new Queue(maxsize);
}
public final class Queue {
private final ArrayBlockingQueue<Entry> queue;
public Queue(final int maxsize) {
this.queue = new ArrayBlockingQueue<Entry>(maxsize);
}
public void put(final Entry e) throws InterruptedException {
this.queue.put(e);
}
public Entry take() throws InterruptedException {
return this.queue.take();
}
public Entry get(final byte[] key) {
for (Entry e: this.queue) {
assert key.length == e.getPrimaryKeyLength();
if (objectOrder.compare(key, 0, e.bytes(), 0, key.length) == 0) {
return e;
}
}
return null;
}
public Entry delete(final byte[] key) {
final Iterator<Entry> i = this.queue.iterator();
Entry e;
while (i.hasNext()) {
e = i.next();
assert key.length == e.getPrimaryKeyLength();
if (objectOrder.compare(key, 0, e.bytes(), 0, key.length) == 0) {
i.remove();
return e;
}
}
return null;
}
}
public final static void long2bytes(long x, final byte[] b, final int offset, final int length) {
for (int i = length - 1; i >= 0; i--) {
b[offset + i] = (byte) (x & 0XFF);
x >>= 8;
}
}
public final static long bytes2long(final byte[] b, final int offset, final int length) {
if (b == null) return 0;
long x = 0;
for (int i = 0; i < length; i++) x = (x << 8) | (0xff & b[offset + i]);
return x;
}
public final boolean subsumes(final Row otherRow) {
// returns true, if this row has at least all columns as the other row
// and possibly some more
if (this.objectsize < otherRow.objectsize) return false;
for (int i = 0; i < otherRow.row.length; i++) {
if ((this.row[i].cellwidth == otherRow.row[i].cellwidth) &&
(this.row[i].celltype == Column.celltype_bitfield) &&
(otherRow.row[i].celltype == Column.celltype_binary)) continue;
if (!(this.row[i].equals(otherRow.row[i]))) return false;
}
return true;
}
@Override
public boolean equals(final Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (!(obj instanceof Row)) return false;
final Row other = (Row) obj;
if (this.objectsize != other.objectsize) return false;
if (this.columns() != other.columns()) return false;
for (int i = 0; i < other.row.length; i++) {
if (!(this.row[i].equals(other.row[i]))) return false;
}
return true;
}
@Override
public int hashCode() {
return this.toString().hashCode();
}
}