com.ibm.es.ama.zing.common.model.axml

Interface Content

All Superinterfaces:

java.lang.Cloneable

public interface Content
extends java.lang.Cloneable

Interface for accessing content component. A content represents each named field in a document.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Content.Builder

Method Summary

Modifier and Type	Method and Description
Content.Builder	builder()
java.lang.String	getCharset()
java.lang.String	getName()
com.ibm.es.ama.datamodel.Field.FieldType	getType()
java.io.Reader	getValueAsReader(boolean deleteOnClose) Reading content value as character stream, using charset for decoding bytes.
java.io.InputStream	getValueAsStream(boolean deleteOnClose) Reading byte content as byte stream.
java.lang.String	getValueAsString() Reading content value as String, using charset for decoding bytes.
boolean	isBytes() Whether content represents bytes value, either on file, or base64-encoded.
boolean	isEpochTime()

Method Detail

getName

java.lang.String getName()

Returns:

content's name.

getType

com.ibm.es.ama.datamodel.Field.FieldType getType()

Returns:

content's type.

isEpochTime

boolean isEpochTime()

Returns:

true, if content's value represents unix epoch time.

isBytes

boolean isBytes()

Whether content represents bytes value, either on file, or base64-encoded.

Returns:

true, if content's value is bytes.

getCharset

java.lang.String getCharset()

Returns:

value of charset representing character encoding for interpreting byte contents.

getValueAsStream

java.io.InputStream getValueAsStream(boolean deleteOnClose)
                              throws AmaIngestionException

Reading byte content as byte stream.

Parameters:

deleteOnClose -

Returns:

InputStream for reading byte content.

Throws:

AmaIngestionException

getValueAsReader

java.io.Reader getValueAsReader(boolean deleteOnClose)
                         throws AmaIngestionException

Reading content value as character stream, using charset for decoding bytes.

Parameters:

deleteOnClose -

Returns:

Reader for reading character stream.

Throws:

AmaIngestionException

getValueAsString

java.lang.String getValueAsString()
                           throws AmaIngestionException

Reading content value as String, using charset for decoding bytes.

Returns:

String value of the content.

Throws:

AmaIngestionException

builder

Content.Builder builder()

Returns:

builder for new content