Part (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.papi.helper.Part

All Implemented Interfaces:

java.io.Serializable
```
public class Part
extends java.lang.Object
implements java.io.Serializable
```
Binary part of a document. The Part represents a part of the content to be converted and indexed. In the most common case, only one part is needed, but you may need to link some attachments to the content.
A part is composed of the following information:
- name: the part name that might be used for configuring the handling of a given part in the indexing chain
- content: represented either through an array of bytes or a stream
- directives: a set of directives to control the processing of the part in the indexing chain (for instance, content mime type, filename, encoding, ...).
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected ContentStream`	`contentStream` Part content.
`protected KeyValuesContainer<java.lang.String,java.lang.String>`	`directives` Part directives.
`static java.lang.String`	`MASTER_PART_NAME` Default name of the master part.
`protected java.lang.String`	`name` Part name.

Constructor Summary

Constructors
Constructor and Description
`Part(byte[] bytes)` Constructor specifying the content as an array of bytes.
`Part(ContentStream data)` Constructor specifying a content stream.
`Part(java.lang.String name, byte[] bytes)` Constructor specifying a part name and an array of bytes.
`Part(java.lang.String name, ContentStream data)` Constructor specifying a part name and a content stream.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCustomDirective(java.lang.String key, java.lang.String value)` Adds a new custom directive.
`void`	`addCustomDirectives(java.lang.String key, java.util.List<java.lang.String> values)` Adds a new multi valued custom directive.
`java.lang.String`	`getCertifiedMime()` Gets the value of the mime directive.
`java.lang.String`	`getCertifiedMine()` Deprecated.
`ContentStream`	`getContentStream()` Deprecated.
`ContentStreamSafe`	`getContentStreamSafe()` Get the part content stream.
`KeyValuesContainer<java.lang.String,java.lang.String>`	`getDirectiveContainer()` Gets the directives container associated with this part.
`java.lang.String`	`getEncoding()` Gets the value of the encoding directive.
`java.lang.String`	`getEncodingHint()` Gets the value of the encodingHint directive.
`java.lang.String`	`getFileName()` Gets the value of the filename directive.
`long`	`getLength()` Get the size of the part content.
`java.lang.String`	`getMimeHint()` Gets the value of the mimeHint directive.
`java.lang.String`	`getName()` Get the part name.
`java.io.InputStream`	`getStream()` Get the underlying content input stream.
`boolean`	`isMaster()` Helper function which checks whether this part is the master part.
`void`	`setAsMaster()` Helper function which sets this part as the master part.
`void`	`setCertifiedMime(java.lang.String value)` Sets the mime directive.
`void`	`setEncoding(java.lang.String value)` Sets the encoding directive.
`void`	`setEncodingHint(java.lang.String value)` Sets the encodingHint directive.
`void`	`setFileName(java.lang.String value)` Sets the filename directive.
`void`	`setMimeHint(java.lang.String value)` Sets the mimeHint directive.
`void`	`setName(java.lang.String name)` Set the part name.

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

- Field Detail
  - MASTER_PART_NAME
```
public static final java.lang.String MASTER_PART_NAME
```
    Default name of the master part.
    
    See Also:
    
    Constant Field Values
  - directives
```
protected KeyValuesContainer<java.lang.String,java.lang.String> directives
```
    Part directives.
  - name
```
protected java.lang.String name
```
    Part name.
  - contentStream
```
protected ContentStream contentStream
```
    Part content. May extends ContentStreamSafe.
- Constructor Detail
  - Part
```
public Part(byte[] bytes)
```
    Constructor specifying the content as an array of bytes. The name of the part is initialized with "master".
    
    Parameters:
    
    bytes - A part of document content.
  - Part
```
public Part(java.lang.String name,
            byte[] bytes)
```
    Constructor specifying a part name and an array of bytes.
    
    Parameters:
    
    name - Part name.
    
    bytes - A part of document content.
  - Part
```
public Part(ContentStream data)
```
    Constructor specifying a content stream. This constructor can be used to optimize the memory consumption when dealing with large content.
    The name of the part is initialized with "master".
    Note that the stream is not automatically closed when the document containing this part has been pushed. It is the responsibility of the API user to manually close the stream.
    
    Parameters:
    
    data - the content stream
  - Part
```
public Part(java.lang.String name,
            ContentStream data)
```
    Constructor specifying a part name and a content stream. This constructor can be used to optimize the memory consumption when dealing with large content.
    Note that the stream is not automatically closed when the document containing this part has been pushed. It is the responsibility of the API user to manually close the stream.
    
    Parameters:
    
    name - the name of the part.
    
    data - the content stream.
- Method Detail
  - getLength
```
public long getLength()
```
    Get the size of the part content.
    
    Returns:
    
    the size of the content or 0 if no content has been set.
  - isMaster
```
public boolean isMaster()
```
    Helper function which checks whether this part is the master part.
    
    Returns:
    
    true if this part is the master part, false otherwise.
  - setAsMaster
```
public void setAsMaster()
```
    Helper function which sets this part as the master part.
  - getName
```
public java.lang.String getName()
```
    Get the part name.
    
    Returns:
    
    the name of the part.
  - setName
```
public void setName(java.lang.String name)
```
    Set the part name.
  - getStream
```
public java.io.InputStream getStream()
```
    Get the underlying content input stream.
    
    Returns:
    
    stream to get content of the part
  - getContentStream
```
@Deprecated
public ContentStream getContentStream()
```
    Deprecated.
    
    Get the part content stream.
    
    Returns:
    
    the part content stream.
  - getContentStreamSafe
```
public ContentStreamSafe getContentStreamSafe()
```
    Get the part content stream.
    
    Returns:
    
    the part content stream.
  - getMimeHint
```
public java.lang.String getMimeHint()
```
    Gets the value of the mimeHint directive. This directive can be used to give a hint to the mime type detector. The detector will use this value to optimize the real mime type detection.
    
    Returns:
    
    the value of the mimeHint directive.
  - setMimeHint
```
public void setMimeHint(java.lang.String value)
```
    Sets the mimeHint directive.
    
    Parameters:
    
    value - the value of the mimeHint directive.
  - getCertifiedMime
```
public java.lang.String getCertifiedMime()
```
    Gets the value of the mime directive. This directive can be used to force the part mime type. If used, the mime type detection step in the indexing chain is just skipped. Use with caution as forcing a wrong mime type might lead to indexing garbage text.
    
    Returns:
    
    the value of the mime directive.
  - getCertifiedMine
```
@Deprecated
public java.lang.String getCertifiedMine()
```
    Deprecated.
  - setCertifiedMime
```
public void setCertifiedMime(java.lang.String value)
```
    Sets the mime directive.
    
    Parameters:
    
    value - the value of the mime directive.
  - getEncoding
```
public java.lang.String getEncoding()
```
    Gets the value of the encoding directive. This directive can be use by the mime type detector as a hint for flat text files mime type detection.
    
    Returns:
    
    the value of the encoding directive.
  - setEncoding
```
public void setEncoding(java.lang.String value)
```
    Sets the encoding directive.
    
    Parameters:
    
    value - the value of the encoding directive.
  - getEncodingHint
```
public java.lang.String getEncodingHint()
```
    Gets the value of the encodingHint directive. This directive can be use by the mime type detector as a hint for flat text files mime type detection.
    
    Returns:
    
    the value of the encoding directive.
  - setEncodingHint
```
public void setEncodingHint(java.lang.String value)
```
    Sets the encodingHint directive.
    
    Parameters:
    
    value - the value of the encoding directive.
  - getFileName
```
public java.lang.String getFileName()
```
    Gets the value of the filename directive. This directive can be used by the binary detector and the text extractor to improve content detection and extraction.
    Most frequent use case is the indexing of Microsoft Office 2007 files. As file content might be zipped, when pushing a part without specifying the filename and thus without giving any hint on the file extension, the file will be detected as a "zip" file and not as a "docx" or "pptx" file.
    
    Returns:
    
    the value of the filename directive.
  - setFileName
```
public void setFileName(java.lang.String value)
```
    Sets the filename directive.
    
    Parameters:
    
    value - the value of the filename directive.
  - addCustomDirective
```
public void addCustomDirective(java.lang.String key,
                               java.lang.String value)
```
    Adds a new custom directive. A custom directive can be used by a customized indexing chain to alter the default application behavior.
    
    Parameters:
    
    key - the directive name
    
    value - the directive value
  - addCustomDirectives
```
public void addCustomDirectives(java.lang.String key,
                                java.util.List<java.lang.String> values)
```
    Adds a new multi valued custom directive. A custom directive can be used by a customized indexing chain to alter the default application behavior.
    
    Parameters:
    
    key - the directive name.
    
    value - the directive value.
  - getDirectiveContainer
```
public KeyValuesContainer<java.lang.String,java.lang.String> getDirectiveContainer()
```
    Gets the directives container associated with this part.
    
    Returns:
    
    the directives container associated with this part.

Class Part

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MASTER_PART_NAME

directives

name

contentStream

Constructor Detail

Part

Part

Part

Part

Method Detail

getLength

isMaster

setAsMaster

getName

setName

getStream

getContentStream

getContentStreamSafe

getMimeHint

setMimeHint

getCertifiedMime

getCertifiedMine

setCertifiedMime

getEncoding

setEncoding

getEncodingHint

setEncodingHint

getFileName

setFileName

addCustomDirective

addCustomDirectives

getDirectiveContainer