org.apache.solr.common.util

Class JavaBinCodec

java.lang.Object

org.apache.solr.common.util.JavaBinCodec

Direct Known Subclasses:

NamedListCodec

public class JavaBinCodec
extends java.lang.Object

The class is designed to optimaly serialize/deserialize any supported types in Solr response. As we know there are only a limited type of items this class can do it with very minimal amount of payload and code. There are 15 known types and if there is an object in the object tree which does not fall into these types, It must be converted to one of these. Implement an ObjectResolver and pass it over It is expected that this class is used on both end of the pipes. The class has one read method and one write method for each of the datatypes

Note -- Never re-use an instance of this class for more than one marshal or unmarshall operation. Always create a new instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JavaBinCodec.ObjectResolver

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ARR
static byte	BOOL_FALSE
static byte	BOOL_TRUE
static byte	BYTE
static byte	BYTEARR
(package private) byte[]	bytes
(package private) char[]	chars
protected FastOutputStream	daos
static byte	DATE
static byte	DOUBLE
static byte	END
protected static java.lang.Object	END_OBJ
static byte	EXTERN_STRING
static byte	FLOAT
static byte	INT
static byte	ITERATOR
static byte	LONG
static byte	MAP
static byte	NAMED_LST
static byte	NULL
static byte	ORDERED_MAP
private JavaBinCodec.ObjectResolver	resolver
static byte	SHORT
static byte	SINT
static byte	SLONG
static byte	SOLRDOC
static byte	SOLRDOCLST
static byte	STR
private int	stringsCount
private java.util.List<java.lang.String>	stringsList
private java.util.Map<java.lang.String,java.lang.Integer>	stringsMap
static byte	TAG_AND_LEN
(package private) byte	tagByte
(package private) byte	version
private static byte	VERSION

Constructor Summary

Constructors

Constructor and Description
JavaBinCodec()
JavaBinCodec(JavaBinCodec.ObjectResolver resolver)

Method Summary

Modifier and Type	Method and Description
void	marshal(java.lang.Object nl, java.io.OutputStream os)
java.util.List	readArray(FastInputStream dis)
byte[]	readByteArray(FastInputStream dis)
java.lang.String	readExternString(FastInputStream fis)
java.util.List	readIterator(FastInputStream fis)
java.util.Map	readMap(FastInputStream dis)
NamedList	readNamedList(FastInputStream dis)
SimpleOrderedMap	readOrderedMap(FastInputStream dis)
int	readSize(FastInputStream in)
int	readSmallInt(FastInputStream dis)
long	readSmallLong(FastInputStream dis)
SolrDocument	readSolrDocument(FastInputStream dis)
SolrDocumentList	readSolrDocumentList(FastInputStream dis)
java.lang.String	readStr(FastInputStream dis)
java.lang.Object	readVal(FastInputStream dis)
static int	readVInt(FastInputStream in) The counterpart for the above
static long	readVLong(FastInputStream in)
java.lang.Object	unmarshal(java.io.InputStream is)
void	writeArray(java.util.Collection coll)
void	writeArray(java.util.List l)
void	writeArray(java.lang.Object[] arr)
void	writeByteArray(byte[] arr, int offset, int len)
void	writeExternString(java.lang.String s)
void	writeInt(int val)
void	writeIterator(java.util.Iterator iter)
boolean	writeKnownType(java.lang.Object val)
void	writeLong(long val)
void	writeMap(java.util.Map val)
void	writeNamedList(NamedList nl)
boolean	writePrimitive(java.lang.Object val)
void	writeSolrDocument(SolrDocument doc)
void	writeSolrDocument(SolrDocument doc, java.util.Set<java.lang.String> fields)
void	writeSolrDocumentList(SolrDocumentList docs)
void	writeStr(java.lang.String s) write the string as tag+length, with length being the number of UTF-8 bytes
void	writeTag(byte tag)
void	writeTag(byte tag, int size)
void	writeVal(java.lang.Object val)
static void	writeVInt(int i, FastOutputStream out) Special method for variable length int (copied from lucene).
static void	writeVLong(long i, FastOutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final byte NULL

See Also:

Constant Field Values

BOOL_TRUE

public static final byte BOOL_TRUE

See Also:

Constant Field Values

BOOL_FALSE

public static final byte BOOL_FALSE

See Also:

Constant Field Values

BYTE

public static final byte BYTE

See Also:

Constant Field Values

SHORT

public static final byte SHORT

See Also:

Constant Field Values

DOUBLE

public static final byte DOUBLE

See Also:

Constant Field Values

INT

public static final byte INT

See Also:

Constant Field Values

LONG

public static final byte LONG

See Also:

Constant Field Values

FLOAT

public static final byte FLOAT

See Also:

Constant Field Values

DATE

public static final byte DATE

See Also:

Constant Field Values

MAP

public static final byte MAP

See Also:

Constant Field Values

SOLRDOC

public static final byte SOLRDOC

See Also:

Constant Field Values

SOLRDOCLST

public static final byte SOLRDOCLST

See Also:

Constant Field Values

BYTEARR

public static final byte BYTEARR

See Also:

Constant Field Values

ITERATOR

public static final byte ITERATOR

See Also:

Constant Field Values

END

public static final byte END

See Also:

Constant Field Values

TAG_AND_LEN

public static final byte TAG_AND_LEN

See Also:

Constant Field Values

STR

public static final byte STR

See Also:

Constant Field Values

SINT

public static final byte SINT

See Also:

Constant Field Values

SLONG

public static final byte SLONG

See Also:

Constant Field Values

ARR

public static final byte ARR

See Also:

Constant Field Values

ORDERED_MAP

public static final byte ORDERED_MAP

See Also:

Constant Field Values

NAMED_LST

public static final byte NAMED_LST

See Also:

Constant Field Values

EXTERN_STRING

public static final byte EXTERN_STRING

See Also:

Constant Field Values

VERSION

private static byte VERSION

resolver

private JavaBinCodec.ObjectResolver resolver

daos

protected FastOutputStream daos

version

byte version

END_OBJ

protected static final java.lang.Object END_OBJ

tagByte

byte tagByte

bytes

byte[] bytes

chars

char[] chars

stringsCount

private int stringsCount

stringsMap

private java.util.Map<java.lang.String,java.lang.Integer> stringsMap

stringsList

private java.util.List<java.lang.String> stringsList

Constructor Detail

JavaBinCodec

public JavaBinCodec()

JavaBinCodec

public JavaBinCodec(JavaBinCodec.ObjectResolver resolver)

Method Detail

marshal

public void marshal(java.lang.Object nl,
                    java.io.OutputStream os)
             throws java.io.IOException

Throws:

java.io.IOException

unmarshal

public java.lang.Object unmarshal(java.io.InputStream is)
                           throws java.io.IOException

Throws:

java.io.IOException

readOrderedMap

public SimpleOrderedMap readOrderedMap(FastInputStream dis)
                                throws java.io.IOException

Throws:

java.io.IOException

readNamedList

public NamedList readNamedList(FastInputStream dis)
                        throws java.io.IOException

Throws:

java.io.IOException

writeNamedList

public void writeNamedList(NamedList nl)
                    throws java.io.IOException

Throws:

java.io.IOException

writeVal

public void writeVal(java.lang.Object val)
              throws java.io.IOException

Throws:

java.io.IOException

readVal

public java.lang.Object readVal(FastInputStream dis)
                         throws java.io.IOException

Throws:

java.io.IOException

writeKnownType

public boolean writeKnownType(java.lang.Object val)
                       throws java.io.IOException

Throws:

java.io.IOException

writeTag

public void writeTag(byte tag)
              throws java.io.IOException

Throws:

java.io.IOException

writeTag

public void writeTag(byte tag,
                     int size)
              throws java.io.IOException

Throws:

java.io.IOException

writeByteArray

public void writeByteArray(byte[] arr,
                           int offset,
                           int len)
                    throws java.io.IOException

Throws:

java.io.IOException

readByteArray

public byte[] readByteArray(FastInputStream dis)
                     throws java.io.IOException

Throws:

java.io.IOException

writeSolrDocument

public void writeSolrDocument(SolrDocument doc)
                       throws java.io.IOException

Throws:

java.io.IOException

writeSolrDocument

public void writeSolrDocument(SolrDocument doc,
                              java.util.Set<java.lang.String> fields)
                       throws java.io.IOException

Throws:

java.io.IOException

readSolrDocument

public SolrDocument readSolrDocument(FastInputStream dis)
                              throws java.io.IOException

Throws:

java.io.IOException

readSolrDocumentList

public SolrDocumentList readSolrDocumentList(FastInputStream dis)
                                      throws java.io.IOException

Throws:

java.io.IOException

writeSolrDocumentList

public void writeSolrDocumentList(SolrDocumentList docs)
                           throws java.io.IOException

Throws:

java.io.IOException

readMap

public java.util.Map readMap(FastInputStream dis)
                      throws java.io.IOException

Throws:

java.io.IOException

writeIterator

public void writeIterator(java.util.Iterator iter)
                   throws java.io.IOException

Throws:

java.io.IOException

readIterator

public java.util.List readIterator(FastInputStream fis)
                            throws java.io.IOException

Throws:

java.io.IOException

writeArray

public void writeArray(java.util.List l)
                throws java.io.IOException

Throws:

java.io.IOException

writeArray

public void writeArray(java.util.Collection coll)
                throws java.io.IOException

Throws:

java.io.IOException

writeArray

public void writeArray(java.lang.Object[] arr)
                throws java.io.IOException

Throws:

java.io.IOException

readArray

public java.util.List readArray(FastInputStream dis)
                         throws java.io.IOException

Throws:

java.io.IOException

writeStr

public void writeStr(java.lang.String s)
              throws java.io.IOException

write the string as tag+length, with length being the number of UTF-8 bytes

Throws:

java.io.IOException

readStr

public java.lang.String readStr(FastInputStream dis)
                         throws java.io.IOException

Throws:

java.io.IOException

writeInt

public void writeInt(int val)
              throws java.io.IOException

Throws:

java.io.IOException

readSmallInt

public int readSmallInt(FastInputStream dis)
                 throws java.io.IOException

Throws:

java.io.IOException

writeLong

public void writeLong(long val)
               throws java.io.IOException

Throws:

java.io.IOException

readSmallLong

public long readSmallLong(FastInputStream dis)
                   throws java.io.IOException

Throws:

java.io.IOException

writePrimitive

public boolean writePrimitive(java.lang.Object val)
                       throws java.io.IOException

Throws:

java.io.IOException

writeMap

public void writeMap(java.util.Map val)
              throws java.io.IOException

Throws:

java.io.IOException

readSize

public int readSize(FastInputStream in)
             throws java.io.IOException

Throws:

java.io.IOException

writeVInt

public static void writeVInt(int i,
                             FastOutputStream out)
                      throws java.io.IOException

Special method for variable length int (copied from lucene). Usually used for writing the length of a collection/array/map In most of the cases the length can be represented in one byte (length < 127) so it saves 3 bytes/object

Parameters:

i -

out -

Throws:

java.io.IOException

readVInt

public static int readVInt(FastInputStream in)
                    throws java.io.IOException

The counterpart for the above

Parameters:

in -

Returns:

the int value

Throws:

java.io.IOException

writeVLong

public static void writeVLong(long i,
                              FastOutputStream out)
                       throws java.io.IOException

Throws:

java.io.IOException

readVLong

public static long readVLong(FastInputStream in)
                      throws java.io.IOException

Throws:

java.io.IOException

writeExternString

public void writeExternString(java.lang.String s)
                       throws java.io.IOException

Throws:

java.io.IOException

readExternString

public java.lang.String readExternString(FastInputStream fis)
                                  throws java.io.IOException

Throws:

java.io.IOException