NDocEncoder (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.papi.helper.utils.NDocEncoder

```
public class NDocEncoder
extends java.lang.Object
```
Class aimed to encode Exalead "NDoc" binary documents.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NDocEncoder.CharSeparatorType` Separator types when inlined in text.
`static class`	`NDocEncoder.CommonMetaNames` Common meta names, to be used with newContext().
`static class`	`NDocEncoder.LanguageId` Language identifier.
`static class`	`NDocEncoder.SeparatorType` Separator types.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`currentContext`
`static java.lang.String`	`MIME_APPLICATION_X_EXALEAD_NDOC` MIME type of a NDoc binary document.
`protected static int`	`NDOC_ANNOTATION_END`
`protected static int`	`NDOC_ANNOTATION_START`
`protected static int`	`NDOC_CHUNK`
`protected static int`	`NDOC_CONTEXT`
`protected static byte`	`NDOC_MAJOR_VERSION`
`protected static int`	`NDOC_MAX`
`protected static byte`	`NDOC_MINOR_VERSION`
`protected static int`	`NDOC_MOT_BINARY`
`protected static int`	`NDOC_SCORE`
`protected static int`	`NDOC_SEPARATOR`
`protected static int`	`NDOC_SIGNATURE`
`protected java.io.ByteArrayOutputStream`	`output`
`static byte[]`	`SIGNATURE`

Constructor Summary

Constructors
Constructor and Description

NDocEncoder()
Create a new NDoc encoder.

Constructors
Constructor and Description
`NDocEncoder()` Create a new NDoc encoder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBinary(byte[] binary)` Add a binary chunk in the current context.
`void`	`addMeta(Meta meta)` Add a meta-data (a text within a specific context)
`void`	`addMeta(java.lang.String name, java.lang.String value)` Add a meta-data (a text within a specific context)
`void`	`addMetas(MetaContainer metas)` Add a set of meta-data.
`void`	`addSeparator(NDocEncoder.SeparatorType sep)` Add a separator.
`protected void`	`addSignature()`
`void`	`addString(java.lang.String string)` Add a text chunk in the current context.
`void`	`addText(java.lang.String text)` Add text as "text" context chunk.
`void`	`endAnnotate(java.lang.String name)` End an annotation.
`void`	`ensureContext(java.lang.String name)` Ensure the given context is entered.
`byte[]`	`getBytes()` Serialize the current NDoc document into an array of bytes.
`static Document`	`getDocumentWithNDocMetas(Document doc)` Takes a Document, compact meta-data into a binary part, and return a new Document version.
`Part`	`getNDocPart()` Get a binary NDoc meta-data part
`static Part`	`getNDocPartFromMetas(MetaContainer metas)` Get a binary NDoc meta-data part, from an existing MetaContainer
`static void`	`main(java.lang.String[] args)` Main sample.
`protected int`	`memRefWrite8(long src)`
`void`	`newContext(java.lang.String name)` Enter in a new context.
`void`	`newContextEx(java.lang.String name, NDocEncoder.LanguageId id)` Enter in a new context.
`protected void`	`push(byte c)`
`protected void`	`push(long c)`
`protected void`	`pushData(byte[] data)`
`protected void`	`pushData(java.lang.String text)`
`protected void`	`pushRawData(byte[] data)`
`protected void`	`pushSize(long size)`
`protected void`	`pushType(int type)`
`void`	`reset()` Reset the current NDoc document, discarding all previous operations.
`void`	`startAnnotate(java.lang.String name, java.lang.String value)` Start an annotation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MIME_APPLICATION_X_EXALEAD_NDOC
```
public static final java.lang.String MIME_APPLICATION_X_EXALEAD_NDOC
```
    MIME type of a NDoc binary document.
    
    See Also:
    
    Constant Field Values
  - NDOC_CHUNK
```
protected static final int NDOC_CHUNK
```
    See Also:
    
    Constant Field Values
  - NDOC_CONTEXT
```
protected static final int NDOC_CONTEXT
```
    See Also:
    
    Constant Field Values
  - NDOC_ANNOTATION_START
```
protected static final int NDOC_ANNOTATION_START
```
    See Also:
    
    Constant Field Values
  - NDOC_ANNOTATION_END
```
protected static final int NDOC_ANNOTATION_END
```
    See Also:
    
    Constant Field Values
  - NDOC_SEPARATOR
```
protected static final int NDOC_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - NDOC_SCORE
```
protected static final int NDOC_SCORE
```
    See Also:
    
    Constant Field Values
  - NDOC_MOT_BINARY
```
protected static final int NDOC_MOT_BINARY
```
    See Also:
    
    Constant Field Values
  - NDOC_MAX
```
protected static final int NDOC_MAX
```
    See Also:
    
    Constant Field Values
  - NDOC_SIGNATURE
```
protected static final int NDOC_SIGNATURE
```
    See Also:
    
    Constant Field Values
  - NDOC_MAJOR_VERSION
```
protected static final byte NDOC_MAJOR_VERSION
```
    See Also:
    
    Constant Field Values
  - NDOC_MINOR_VERSION
```
protected static final byte NDOC_MINOR_VERSION
```
    See Also:
    
    Constant Field Values
  - SIGNATURE
```
public static final byte[] SIGNATURE
```
  - output
```
protected final java.io.ByteArrayOutputStream output
```
  - currentContext
```
protected java.lang.String currentContext
```
- Constructor Detail
  - NDocEncoder
```
public NDocEncoder()
```
    Create a new NDoc encoder.
- Method Detail
  - push
```
protected void push(byte c)
```
  - push
```
protected void push(long c)
```
  - pushRawData
```
protected void pushRawData(byte[] data)
```
  - pushSize
```
protected void pushSize(long size)
```
  - pushData
```
protected void pushData(byte[] data)
```
  - pushData
```
protected void pushData(java.lang.String text)
```
  - memRefWrite8
```
protected int memRefWrite8(long src)
```
  - pushType
```
protected void pushType(int type)
```
  - addSignature
```
protected void addSignature()
```
  - addString
```
public void addString(java.lang.String string)
```
    Add a text chunk in the current context.
    Note: use addText() to add text in "text" context.
    
    Parameters:
    
    string - The string chunk.
  - addBinary
```
public void addBinary(byte[] binary)
```
    Add a binary chunk in the current context.
    
    Parameters:
    
    binary - The binary chunk.
  - addText
```
public void addText(java.lang.String text)
```
    Add text as "text" context chunk.
    
    Parameters:
    
    text - The text to be added.
  - newContextEx
```
public void newContextEx(java.lang.String name,
                         NDocEncoder.LanguageId id)
```
    Enter in a new context.
    
    Parameters:
    
    name - The context name (such as "text") ; see @c CommonMetaNames
    
    id - The language identifier
  - newContext
```
public void newContext(java.lang.String name)
```
    Enter in a new context.
    
    Parameters:
    
    name - The context name (such as "text") ; see @c CommonMetaNames
  - ensureContext
```
public void ensureContext(java.lang.String name)
```
    Ensure the given context is entered.
    
    Parameters:
    
    name - The context name (such as "text") ; see @c CommonMetaNames
  - addMeta
```
public void addMeta(java.lang.String name,
                    java.lang.String value)
```
    Add a meta-data (a text within a specific context)
    
    Parameters:
    
    name - The meta name
    
    value - The associated meta text
  - addMeta
```
public void addMeta(Meta meta)
```
    Add a meta-data (a text within a specific context)
    
    Parameters:
    
    meta - The meta to be added.
  - addMetas
```
public void addMetas(MetaContainer metas)
```
    Add a set of meta-data.
    
    Parameters:
    
    metas - The meta set to be added.
  - addSeparator
```
public void addSeparator(NDocEncoder.SeparatorType sep)
```
    Add a separator.
    
    Parameters:
    
    sep - The separator to be added.
  - startAnnotate
```
public void startAnnotate(java.lang.String name,
                          java.lang.String value)
```
    Start an annotation.
    
    Parameters:
    
    name - The annotation name to be started.
    
    value - The annotation optional value.
  - endAnnotate
```
public void endAnnotate(java.lang.String name)
```
    End an annotation.
    
    Parameters:
    
    name - The annotation name to be ended.
  - reset
```
public void reset()
```
    Reset the current NDoc document, discarding all previous operations.
  - getBytes
```
public byte[] getBytes()
```
    Serialize the current NDoc document into an array of bytes.
    
    Returns:
    
    The NDoc opaque bytes (of type NDocEncoder.MIME_APPLICATION_X_EXALEAD_NDOC).
  - getNDocPart
```
public Part getNDocPart()
```
    Get a binary NDoc meta-data part
    
    Returns:
    
    The NDoc binary part to replace the meta-data container
  - getNDocPartFromMetas
```
public static Part getNDocPartFromMetas(MetaContainer metas)
```
    Get a binary NDoc meta-data part, from an existing MetaContainer
    
    Parameters:
    
    metas - The meta-data set
    
    Returns:
    
    The NDoc binary part to replace the meta-data container
  - getDocumentWithNDocMetas
```
public static Document getDocumentWithNDocMetas(Document doc)
                                         throws PushAPIException
```
    Takes a Document, compact meta-data into a binary part, and return a new Document version.
    
    Parameters:
    
    doc - The original document.
    
    Returns:
    
    A new document with meta-data compacted into a binary part.
    
    Throws:
    
    PushAPIException - Upon error.
  - main
```
public static void main(java.lang.String[] args)
                 throws java.io.IOException
```
    Main sample.
    
    Parameters:
    
    args - Arguments.
    
    Throws:
    
    java.io.IOException - Upon I/O error.

Class NDocEncoder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIME_APPLICATION_X_EXALEAD_NDOC

NDOC_CHUNK

NDOC_CONTEXT

NDOC_ANNOTATION_START

NDOC_ANNOTATION_END

NDOC_SEPARATOR

NDOC_SCORE

NDOC_MOT_BINARY

NDOC_MAX

NDOC_SIGNATURE

NDOC_MAJOR_VERSION

NDOC_MINOR_VERSION

SIGNATURE

output

currentContext

Constructor Detail

NDocEncoder

Method Detail

push

push

pushRawData

pushSize

pushData

pushData

memRefWrite8

pushType

addSignature

addString

addBinary

addText

newContextEx

newContext

ensureContext

addMeta

addMeta

addMetas

addSeparator

startAnnotate

endAnnotate

reset

getBytes

getNDocPart

getNDocPartFromMetas

getDocumentWithNDocMetas

main