A B C D F G I L M P R S T V

A

addSize(long) - Method in interface com.ibm.es.ama.zing.common.model.axml.Document.Builder

Add the byte size of document data.

AmaIngestionException - Exception in com.ibm.es.ama.zing.common

AmaIngestionException() - Constructor for exception com.ibm.es.ama.zing.common.AmaIngestionException

AmaIngestionException(String) - Constructor for exception com.ibm.es.ama.zing.common.AmaIngestionException

AmaIngestionException(String, String[]) - Constructor for exception com.ibm.es.ama.zing.common.AmaIngestionException

AmaIngestionException(String, Throwable) - Constructor for exception com.ibm.es.ama.zing.common.AmaIngestionException

AmaIngestionException(String, String[], Throwable) - Constructor for exception com.ibm.es.ama.zing.common.AmaIngestionException

append(T) - Method in interface com.ibm.es.ama.zing.common.model.axml.AXMLBase.Publisher

appendAll(Iterable<? extends T>) - Method in interface com.ibm.es.ama.zing.common.model.axml.AXMLBase.Publisher

AXML<S extends AXML<S,T>,T> - Interface in com.ibm.es.ama.zing.common.model.axml

Basic interface for AXML data with on-memory child components, which are accessed by java.util.Iterable interface.

AXMLBase<S extends AXMLBase<S,T>,T> - Interface in com.ibm.es.ama.zing.common.model.axml

AXMLBase.Builder<S> - Interface in com.ibm.es.ama.zing.common.model.axml

Interface for setting properties to newly build AXML object.

AXMLBase.Publisher<T> - Interface in com.ibm.es.ama.zing.common.model.axml

Interface for appending child components to newly built AXML object.

B

build(Consumer<AXMLBase.Publisher<? super Document>>) - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlData

build(Consumer<AXMLBase.Publisher<? super T>>) - Method in interface com.ibm.es.ama.zing.common.model.axml.LazyAXML

Build a new instance of this class by calculating child components lazily.

builder() - Method in interface com.ibm.es.ama.zing.common.model.axml.AXML

Create a builder for new AXML component cloned from this object, but with empty children.

builder() - Method in interface com.ibm.es.ama.zing.common.model.axml.Content

builder() - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlUrl

builder() - Method in interface com.ibm.es.ama.zing.common.model.axml.Document

C

canProcess(CrawlData) - Method in interface com.ibm.es.ama.zing.common.model.converter.ConverterBase

The implementation of this method tests whether or not the given crawl-data can be processed by this converter, typically by examining the value of content-type and url of the crawl-data.

canReadMetadataFrom(CrawlData) - Method in interface com.ibm.es.ama.zing.common.model.converter.ConverterBase

The implementation of this method tests whether or not the given crawl-data can be used as metadata during the conversion.

com.ibm.es.ama.zing.common - package com.ibm.es.ama.zing.common

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

com.ibm.es.ama.zing.common.model.converter - package com.ibm.es.ama.zing.common.model.converter

compiledConditional() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

compiledTypeIn() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

compiledTypeMeta() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

configure(Map<String, String>) - Method in interface com.ibm.es.ama.zing.common.model.converter.CustomConverterPlugin

Interface method to configure this converter plugin by given parameters.

Content - Interface in com.ibm.es.ama.zing.common.model.axml

Interface for accessing content component.

Content.Builder - Interface in com.ibm.es.ama.zing.common.model.axml

convert(Document, AXMLBase.Publisher<? super Document>, Iterable<Document>) - Method in interface com.ibm.es.ama.zing.common.model.converter.CustomConverterPlugin

Interface method for implementing document-level conversion.

ConverterBase - Interface in com.ibm.es.ama.zing.common.model.converter

ConverterBase.ConverterStatus - Enum in com.ibm.es.ama.zing.common.model.converter

Representing the status of conversion.

ConverterConfiguration - Class in com.ibm.es.ama.zing.common.model.converter

ConverterConfiguration() - Constructor for class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

ConverterConfiguration.GeneralSettings - Class in com.ibm.es.ama.zing.common.model.converter

copy() - Method in interface com.ibm.es.ama.zing.common.model.axml.AXMLBase

Create a builder for new AXML component cloned from this object.

copy() - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlData

copy() - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlUrl

CrawlData - Interface in com.ibm.es.ama.zing.common.model.axml

Interface for accessing crawl-data component.

CrawlData.Builder - Interface in com.ibm.es.ama.zing.common.model.axml

Builder for new crawl-data.

CrawlUrl - Interface in com.ibm.es.ama.zing.common.model.axml

Interface for accessing crawl-url, which is top-level container of AXML documents.

CrawlUrl.Builder - Interface in com.ibm.es.ama.zing.common.model.axml

CustomConverterPlugin - Interface in com.ibm.es.ama.zing.common.model.converter

Interface for all custom converter plugins.

D

Document - Interface in com.ibm.es.ama.zing.common.model.axml

Interface for accessing document component.

Document.Builder - Interface in com.ibm.es.ama.zing.common.model.axml

Interface for building Docuemnt object.

F

forcesDeletion() - Method in interface com.ibm.es.ama.zing.common.model.converter.ConverterBase

The implementation of this method defines a flag as to whether or not the deletion is issued for any old document with url that matches by prefix to url of crawl-data that is processed by this converter, before the results of this converter are added to the dataset.

forcesDeletion() - Method in interface com.ibm.es.ama.zing.common.model.converter.CustomConverterPlugin

forEach(AXMLBase.Publisher<? super T>) - Method in interface com.ibm.es.ama.zing.common.model.axml.LazyAXML

Applies action on all children of this object.

forEachBuild(BiConsumer<Document, AXMLBase.Publisher<? super Document>>) - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlData

forEachBuild(BiConsumer<T, AXMLBase.Publisher<? super T>>) - Method in interface com.ibm.es.ama.zing.common.model.axml.LazyAXML

Build a new instance of this class whose contents are calculated lazily.

G

GeneralSettings() - Constructor for class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

get() - Method in interface com.ibm.es.ama.zing.common.model.axml.AXMLBase.Builder

Retrieves the object built by this builder.

get() - Method in interface com.ibm.es.ama.zing.common.model.axml.Content.Builder

Return a content built by this builder.

getAcl() - Method in interface com.ibm.es.ama.zing.common.model.axml.AXMLBase

getArgs() - Method in exception com.ibm.es.ama.zing.common.AmaIngestionException

getAuxiliarySettings() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getCharset() - Method in interface com.ibm.es.ama.zing.common.model.axml.Content

getConditional() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

getConditional() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getConfiguration() - Method in interface com.ibm.es.ama.zing.common.model.converter.ConverterBase

getConfiguration() - Method in interface com.ibm.es.ama.zing.common.model.converter.CustomConverterPlugin

getContentType() - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlData

Get content-type of documents in this crawl-data.

getConverterName() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

getConverterName() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getConverterSettings() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getCrawlerId() - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlUrl

The id of crawler for this crawl-url.

getCrawlSpaceId() - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlUrl

The id of crawlspace for this crawl-url.

getGeneralSettings() - Method in interface com.ibm.es.ama.zing.common.model.converter.ConverterBase

getGeneralSettings() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getGroupID() - Method in interface com.ibm.es.ama.zing.common.model.axml.AXMLBase

Get group-id which is a key for joining separate documents after they're published as dataset.

getIterator() - Method in interface com.ibm.es.ama.zing.common.model.axml.AXML

getLocalizedMessage() - Method in exception com.ibm.es.ama.zing.common.AmaIngestionException

getLogRecord() - Method in exception com.ibm.es.ama.zing.common.AmaIngestionException

getLogRecord(Level) - Method in exception com.ibm.es.ama.zing.common.AmaIngestionException

getName() - Method in interface com.ibm.es.ama.zing.common.model.axml.Content

getName() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getParameterAsArray(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getParameterAsBoolean(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getParameterAsDouble(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getParameterAsInt(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getParameterAsLong(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getParameterAsMap(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getParameterAsString(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getSize() - Method in interface com.ibm.es.ama.zing.common.model.axml.Document

Return the byte size of document data.

getType() - Method in interface com.ibm.es.ama.zing.common.model.axml.Content

getType() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getTypeIn() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

getTypeIn() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getTypeMeta() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

getTypeOut() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

getTypeOut() - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

getUrl() - Method in interface com.ibm.es.ama.zing.common.model.axml.AXMLBase

Get url which represents URL of this AXML component.

getValueAsReader(boolean) - Method in interface com.ibm.es.ama.zing.common.model.axml.Content

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

getValueAsStream(boolean) - Method in interface com.ibm.es.ama.zing.common.model.axml.Content

Reading byte content as byte stream.

getValueAsString() - Method in interface com.ibm.es.ama.zing.common.model.axml.Content

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

I

isBytes() - Method in interface com.ibm.es.ama.zing.common.model.axml.Content

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

isEpochTime() - Method in interface com.ibm.es.ama.zing.common.model.axml.Content

iterator() - Method in interface com.ibm.es.ama.zing.common.model.axml.AXML

L

LazyAXML<S extends LazyAXML<S,T>,T> - Interface in com.ibm.es.ama.zing.common.model.axml

Basic interface for AXML data with lazy child components, which are accessed as streams.

logger() - Method in interface com.ibm.es.ama.zing.common.model.converter.ConverterBase

M

main(String[]) - Static method in interface com.ibm.es.ama.zing.common.model.converter.CustomConverterPlugin

Command line test runner's main method.

map(Function<? super Document, ? extends Document>) - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlData

map(Function<? super T, ? extends T>) - Method in interface com.ibm.es.ama.zing.common.model.axml.LazyAXML

P

postProcess(CrawlData, CrawlData.Builder) - Method in interface com.ibm.es.ama.zing.common.model.converter.ConverterBase

The implementation of this method modifies crawl-data after the conversion.

R

removesMetadata() - Method in interface com.ibm.es.ama.zing.common.model.converter.ConverterBase

The implementation of this method defines a flag as to whether or not after the conversion, this converter removes metadata, i.e., crawl-data for which canReadMetadataFrom is true, from the output.

removesMetadata() - Method in interface com.ibm.es.ama.zing.common.model.converter.CustomConverterPlugin

S

setAuxiliarySettings(JsonNode) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

setCharset(String) - Method in interface com.ibm.es.ama.zing.common.model.axml.Content.Builder

Set charset of the content.

setConditional(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

setContentType(String) - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlData.Builder

Set content-type of documents in this crawl-data.

setConverterName(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

setConverterSettings(Map<String, Object>) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

setCrawlerId(String) - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlUrl.Builder

Set the id of crawler for new crawl-url.

setCrawlSpaceId(String) - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlUrl.Builder

Set the id of crawlspace for new crawl-url.

setForceDeletion(boolean) - Method in interface com.ibm.es.ama.zing.common.model.axml.CrawlUrl.Builder

When true, issue deletion for any old dataset document with url that matches url as a prefix, before publishing new documents.

setGeneralSettings(ConverterConfiguration.GeneralSettings) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

setGroupID(String) - Method in interface com.ibm.es.ama.zing.common.model.axml.AXMLBase.Builder

Set group-id which is a key for joining separate documents after they're published as dataset.

setName(String) - Method in interface com.ibm.es.ama.zing.common.model.axml.Content.Builder

Set content's name

setName(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

setSize(long) - Method in interface com.ibm.es.ama.zing.common.model.axml.Document.Builder

Set the byte size of document data.

setType(Field.FieldType) - Method in interface com.ibm.es.ama.zing.common.model.axml.Content.Builder

Set content's type

setType(ConverterType) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration

setTypeIn(String[]) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

setTypeMeta(String[]) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

setTypeOut(String) - Method in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

setUrl(String) - Method in interface com.ibm.es.ama.zing.common.model.axml.AXMLBase.Builder

Set url which represents URL of this AXML component.

setValueFromBytes(byte[]) - Method in interface com.ibm.es.ama.zing.common.model.axml.Content.Builder

Set content's byte value.

setValueFromFile(File) - Method in interface com.ibm.es.ama.zing.common.model.axml.Content.Builder

Set content's byte value from a file.

setValueFromString(String) - Method in interface com.ibm.es.ama.zing.common.model.axml.Content.Builder

Set conten't value from string

T

TYPEIN_ALL - Static variable in class com.ibm.es.ama.zing.common.model.converter.ConverterConfiguration.GeneralSettings

V

valueOf(String) - Static method in enum com.ibm.es.ama.zing.common.model.converter.ConverterBase.ConverterStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.ibm.es.ama.zing.common.model.converter.ConverterBase.ConverterStatus

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D F G I L M P R S T V