Module org.apache.lucene.core

Package org.apache.lucene.document

Class ShapeDocValues.Reader

java.lang.Object

org.apache.lucene.store.DataInput

org.apache.lucene.document.ShapeDocValues.Reader

All Implemented Interfaces:

Cloneable

Enclosing class:

ShapeDocValues

private final class ShapeDocValues.Reader
extends DataInput

Reads values from a ShapeDocValues Field

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	ShapeDocValues.Reader.BBox
private final class	ShapeDocValues.Reader.Header

Field Summary

Fields

Modifier and Type	Field	Description
private final ShapeDocValues.Reader.BBox	bbox
private final ByteArrayDataInput	data	data input array to read the docvalue data

Constructor Summary

Constructors

Constructor	Description
Reader(BytesRef binaryValue)	creates the docvalue reader from the binary value

Method Summary

Modifier and Type	Method	Description
ShapeDocValues.Reader	clone()	Returns a clone of this stream.
private SpatialQuery.EncodedRectangle	readBBox()	reads the component bounding box
byte	readByte()	Reads and returns a single byte.
void	readBytes(byte[] b, int offset, int len)	Reads a specified number of bytes into an array at the specified offset.
private SpatialQuery.EncodedRectangle	resetBBox(int minX, int maxX, int minY, int maxY)	resets the scratch bounding box
protected void	rewind()	rewinds the buffer to the beginning
void	skipBytes(long numBytes)	Skip over numBytes bytes.

Methods inherited from class org.apache.lucene.store.DataInput

readBytes, readFloats, readGroupVInt, readInt, readInts, readLong, readLongs, readMapOfStrings, readSetOfStrings, readShort, readString, readVInt, readVLong, readZInt, readZLong

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

data

private final ByteArrayDataInput data

data input array to read the docvalue data

bbox

private final ShapeDocValues.Reader.BBox bbox

Constructor Details

Reader

Reader(BytesRef binaryValue)

creates the docvalue reader from the binary value

Method Details

clone

public ShapeDocValues.Reader clone()

Description copied from class: DataInput

Returns a clone of this stream.

Clones of a stream access the same data, and are positioned at the same point as the stream they were cloned from.

Expert: Subclasses must ensure that clones may be positioned at different points in the input from each other and from the stream they were cloned from.

Overrides:

clone in class DataInput

rewind

protected void rewind()

rewinds the buffer to the beginning

readBBox

private SpatialQuery.EncodedRectangle readBBox()

reads the component bounding box

resetBBox

private SpatialQuery.EncodedRectangle resetBBox(int minX,
 int maxX,
 int minY,
 int maxY)

resets the scratch bounding box

readByte

public byte readByte()
              throws IOException

Description copied from class: DataInput

Reads and returns a single byte.

Specified by:

readByte in class DataInput

Throws:

IOException

See Also:

• DataOutput.writeByte(byte)

readBytes

public void readBytes(byte[] b,
 int offset,
 int len)
               throws IOException

Description copied from class: DataInput

Reads a specified number of bytes into an array at the specified offset.

Specified by:

readBytes in class DataInput

Parameters:

b - the array to read bytes into

offset - the offset in the array to start storing bytes

len - the number of bytes to read

Throws:

IOException

See Also:

• DataOutput.writeBytes(byte[],int)

skipBytes

public void skipBytes(long numBytes)
               throws IOException

Description copied from class: DataInput

Skip over numBytes bytes. This method may skip bytes in whatever way is most optimal, and may not have the same behavior as reading the skipped bytes. In general, negative numBytes are not supported.

Specified by:

skipBytes in class DataInput

Throws:

IOException