A B C D E F G H I J M N P R S T W

A

Adapter - Interface in com.endeca.edf.adapter

The Adapter interface provides for extracting records from a data source.

AdapterConfig - Class in com.endeca.edf.adapter

Contains configuration information handed to the adapter class via the execute method.

AdapterConfig() - Constructor for class com.endeca.edf.adapter.AdapterConfig

Constructs a new configuration container that is empty.

AdapterError - Error in com.endeca.edf.adapter

The AdapterError represents all errors thrown by Adapter related classes.

AdapterError() - Constructor for error com.endeca.edf.adapter.AdapterError

Constructs an AdapterError with no specified detail message.

AdapterError(String) - Constructor for error com.endeca.edf.adapter.AdapterError

Constructs an AdapterError with given detail message.

AdapterError(String, Throwable) - Constructor for error com.endeca.edf.adapter.AdapterError

Constructs an AdapterError with a detail message and cause.

AdapterError(Throwable) - Constructor for error com.endeca.edf.adapter.AdapterError

Constructs an AdapterError with the specified cause.

AdapterException - Exception in com.endeca.edf.adapter

The AdapterException represents all exceptions thrown by Adapter related classes.

AdapterException() - Constructor for exception com.endeca.edf.adapter.AdapterException

Constructs an AdapterException with no specified detail message.

AdapterException(String) - Constructor for exception com.endeca.edf.adapter.AdapterException

Constructs an AdapterException with given detail message.

AdapterException(String, Throwable) - Constructor for exception com.endeca.edf.adapter.AdapterException

Constructs an AdapterException with a detail message and cause.

AdapterException(Throwable) - Constructor for exception com.endeca.edf.adapter.AdapterException

Constructs an AdapterException with the specified cause.

AdapterHandler - Class in com.endeca.edf.adapter

A functor used by an adapter to emit records.

add(PVal) - Method in class com.endeca.edf.adapter.Record

Adds a pval to this record.

add(PVal[]) - Method in class com.endeca.edf.adapter.Record

Adds pvals to this record.

available() - Method in class com.endeca.edf.adapter.BinaryFormatInputStream

B

BinaryFormatInputStream - Class in com.endeca.edf.adapter

BinaryFormatInputStream(InputStream) - Constructor for class com.endeca.edf.adapter.BinaryFormatInputStream

BinaryFormatInputStream.BinaryFormatException - Exception in com.endeca.edf.adapter

BinaryFormatInputStream.BinaryFormatException(String) - Constructor for exception com.endeca.edf.adapter.BinaryFormatInputStream.BinaryFormatException

BinaryFormatOutputStream - Class in com.endeca.edf.adapter

BinaryFormatOutputStream(OutputStream) - Constructor for class com.endeca.edf.adapter.BinaryFormatOutputStream

BinaryRecordReader - Class in com.endeca.edf.adapter

BinaryRecordReader(BinaryFormatInputStream) - Constructor for class com.endeca.edf.adapter.BinaryRecordReader

C

close() - Method in class com.endeca.edf.adapter.BinaryFormatInputStream

close() - Method in class com.endeca.edf.adapter.BinaryFormatOutputStream

COLUMN_HANDLER_CLASSNAME - Static variable in class com.endeca.edf.adapter.plugins.JdbcAdapter

com.endeca.edf.adapter - package com.endeca.edf.adapter

This package provides the framework for developing pluggable adapters.

com.endeca.edf.adapter.plugins - package com.endeca.edf.adapter.plugins

This package is a collection of pluggable adapters built by Endeca using the CADK framework.

compareTo(PVal) - Method in class com.endeca.edf.adapter.PVal

configure(AdapterConfig) - Method in class com.endeca.edf.adapter.plugins.WebDAVPlugin

This method is called at the beginning of execute before any processing occurs.

containsName(String) - Method in class com.endeca.edf.adapter.AdapterConfig

Tests to see if any values are associated with the given name.

D

DB_CONNECT_PROP - Static variable in class com.endeca.edf.adapter.plugins.JdbcAdapter

DB_DRIVER_CLASS - Static variable in class com.endeca.edf.adapter.plugins.JdbcAdapter

DB_PASSWORD - Static variable in class com.endeca.edf.adapter.plugins.JdbcAdapter

DB_URL - Static variable in class com.endeca.edf.adapter.plugins.JdbcAdapter

DB_USER - Static variable in class com.endeca.edf.adapter.plugins.JdbcAdapter

DefaultJdbcColumnHandler - Class in com.endeca.edf.adapter.plugins

DefaultJdbcColumnHandler() - Constructor for class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

E

emit(Record) - Method in class com.endeca.edf.adapter.AdapterHandler

Send a record off to be processed by this handler.

equals(Object) - Method in class com.endeca.edf.adapter.PVal

ExchangePlugin - Class in com.endeca.edf.adapter.plugins

A Microsoft Exchange 2000 and beyond plugin that is based on the WebDAV plugin.

ExchangePlugin() - Constructor for class com.endeca.edf.adapter.plugins.ExchangePlugin

execute(AdapterConfig, AdapterHandler) - Method in interface com.endeca.edf.adapter.Adapter

Uses the configuration given to construct records and emits each record to the adapter handler provided.

execute(AdapterConfig, AdapterHandler) - Method in class com.endeca.edf.adapter.plugins.JdbcAdapter

execute this Adapter

execute(AdapterConfig, AdapterHandler) - Method in class com.endeca.edf.adapter.plugins.WebDAVPlugin

Adpater Interface

F

first(String) - Method in class com.endeca.edf.adapter.AdapterConfig

Retrieves the first value associated with the given name (this corresponds to the first value stored under this name).

firstDoubleOrDefault(String, double) - Method in class com.endeca.edf.adapter.AdapterConfig

Same as firstOrDefault(), but throws an AdapterException if the value cannot be converted into a double.

firstIntOrDefault(String, int) - Method in class com.endeca.edf.adapter.AdapterConfig

Same as firstOrDefault(), but throws an AdapterException if the value cannot be converted into an integer.

firstOrDefault(String, String) - Method in class com.endeca.edf.adapter.AdapterConfig

Same as first(), but returns defaultValue if there is no value associated with the given name.

flushLog() - Method in class com.endeca.edf.adapter.AdapterHandler

Flush any log messages that have been buffered.

G

get(String) - Method in class com.endeca.edf.adapter.AdapterConfig

Retrieves a string array of values associated with the given name.

get(OutputStream) - Static method in class com.endeca.edf.adapter.BinaryFormatOutputStream

get(int) - Method in class com.endeca.edf.adapter.Record

Returns the pval at the specified position in this record.

getInputDirectory() - Method in class com.endeca.edf.adapter.AdapterHandler

Gets the input, state, or tmp directory used by forge.

getName() - Method in class com.endeca.edf.adapter.AdapterHandler

getName() - Method in class com.endeca.edf.adapter.PVal

Gets the name of this PVal.

getNumInputs() - Method in class com.endeca.edf.adapter.AdapterHandler

getPercentComplete(int) - Method in class com.endeca.edf.adapter.AdapterHandler

getPercentComplete() - Method in class com.endeca.edf.adapter.AdapterHandler

Get the current completion level for this adapter.

getRecord(int) - Method in class com.endeca.edf.adapter.AdapterHandler

Get a record from the specified record input in forge.

getRecord(String) - Method in class com.endeca.edf.adapter.AdapterHandler

Get a record from the specified input in forge.

getRecord() - Method in class com.endeca.edf.adapter.AdapterHandler

getStateDirectory() - Method in class com.endeca.edf.adapter.AdapterHandler

getTmpDirectory() - Method in class com.endeca.edf.adapter.AdapterHandler

getTotalNumberOfRecordsToEmit() - Method in class com.endeca.edf.adapter.AdapterHandler

Get the total number of records that are to be emitted.

getValue() - Method in class com.endeca.edf.adapter.PVal

Gets the value of this PVal.

H

handle_ARRAY(Array, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_ARRAY(Array, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_BIGINT(long, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_BIGINT(long, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_BINARY(byte[], ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_BINARY(byte[], ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_BIT(boolean, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_BIT(boolean, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_BLOB(Blob, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_BLOB(Blob, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_BOOLEAN(boolean, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_BOOLEAN(boolean, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_CHAR(String, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_CHAR(String, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_CLOB(Clob, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_CLOB(Clob, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_DATALINK(URL, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_DATALINK(URL, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_DATE(Date, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_DATE(Date, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_DECIMAL(BigDecimal, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_DECIMAL(BigDecimal, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_DISTINCT(Object, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_DISTINCT(Object, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_DOUBLE(double, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_DOUBLE(double, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_FLOAT(double, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_FLOAT(double, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_INTEGER(int, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_INTEGER(int, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_JAVA_OBJECT(Object, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_JAVA_OBJECT(Object, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_LONGVARBINARY(InputStream, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_LONGVARBINARY(InputStream, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_LONGVARCHAR(Reader, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_LONGVARCHAR(Reader, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_NUMERIC(BigDecimal, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_NUMERIC(BigDecimal, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_OTHER(Object, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_OTHER(Object, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_REAL(float, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_REAL(float, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_REF(Ref, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_REF(Ref, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_SMALLINT(short, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_SMALLINT(short, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_STRUCT(Object, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_STRUCT(Object, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_TIME(Time, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_TIME(Time, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_TIMESTAMP(Timestamp, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_TIMESTAMP(Timestamp, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_TINYINT(byte, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_TINYINT(byte, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_VARBINARY(byte[], ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_VARBINARY(byte[], ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handle_VARCHAR(String, ResultSetMetaData, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handle_VARCHAR(String, ResultSetMetaData, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnTypeHandler

handleColumn(ResultSet, int) - Method in class com.endeca.edf.adapter.plugins.DefaultJdbcColumnHandler

handleColumn(ResultSet, int) - Method in interface com.endeca.edf.adapter.plugins.JdbcColumnHandler

hashCode() - Method in class com.endeca.edf.adapter.PVal

hasNext() - Method in class com.endeca.edf.adapter.BinaryRecordReader

I

iterator() - Method in class com.endeca.edf.adapter.Record

Returns an iterator of the pvals in this record (in proper sequence).

J

JdbcAdapter - Class in com.endeca.edf.adapter.plugins

JdbcAdapter() - Constructor for class com.endeca.edf.adapter.plugins.JdbcAdapter

JdbcAdapterException - Exception in com.endeca.edf.adapter.plugins

JdbcAdapterException(String) - Constructor for exception com.endeca.edf.adapter.plugins.JdbcAdapterException

JdbcAdapterException(String, Throwable) - Constructor for exception com.endeca.edf.adapter.plugins.JdbcAdapterException

JdbcColumnHandler - Interface in com.endeca.edf.adapter.plugins

JdbcColumnTypeHandler - Interface in com.endeca.edf.adapter.plugins

M

main(String[]) - Static method in class com.endeca.edf.adapter.BinaryFormatOutputStream

map - Variable in class com.endeca.edf.adapter.AdapterConfig

N

nameSet() - Method in class com.endeca.edf.adapter.AdapterConfig

Provides a set of all names contained within this object.

next() - Method in class com.endeca.edf.adapter.BinaryRecordReader

P

put(String, String) - Method in class com.endeca.edf.adapter.AdapterConfig

Add a name-value pair to the configuration (a name can be associated with multiple values).

put(String, String[]) - Method in class com.endeca.edf.adapter.AdapterConfig

Add values associated with the given name to the configuration.

PVal - Class in com.endeca.edf.adapter

A name-value pair, a collection of which constitutes a Record.

PVal(String, String) - Constructor for class com.endeca.edf.adapter.PVal

Constructs a PVal from a name and a value.

R

readBoolean() - Method in class com.endeca.edf.adapter.BinaryFormatInputStream

readDouble() - Method in class com.endeca.edf.adapter.BinaryFormatInputStream

readFully(byte[], int, int) - Method in class com.endeca.edf.adapter.BinaryFormatInputStream

readInt() - Method in class com.endeca.edf.adapter.BinaryFormatInputStream

readLong() - Method in class com.endeca.edf.adapter.BinaryFormatInputStream

readString() - Method in class com.endeca.edf.adapter.BinaryFormatInputStream

Record - Class in com.endeca.edf.adapter

A collection of data in the form of pvals, name-value pairs.

Record() - Constructor for class com.endeca.edf.adapter.Record

Constructs a new Record containing no data.

requiredFirst(String) - Method in class com.endeca.edf.adapter.AdapterConfig

Same as first(), but throws an AdapterException if there is no value associated with the given name.

S

serialize(BinaryFormatOutputStream) - Method in class com.endeca.edf.adapter.Record

serialize(XMLWriter) - Method in class com.endeca.edf.adapter.Record

setAutoFlushLog(boolean) - Method in class com.endeca.edf.adapter.AdapterHandler

Set whether log messages are flushed as soon as they are logged.

setName(String) - Method in class com.endeca.edf.adapter.PVal

Sets the name of this PVal.

setPercentComplete(double) - Method in class com.endeca.edf.adapter.AdapterHandler

Set the current completion level for this adapter.

setTotalNumberOfRecordsToEmit(long) - Method in class com.endeca.edf.adapter.AdapterHandler

Sets the total number of records that are to be emitted.

setValue(String) - Method in class com.endeca.edf.adapter.PVal

Sets the value of this PVal.

ShutdownRequestAdapterException - Exception in com.endeca.edf.adapter

The ShutdownRequestAdapterException is thrown to notify the caller that the adapter handler that is processing records, will no longer process records handed to it.

size() - Method in class com.endeca.edf.adapter.Record

Returns the number of pvals contained in this record.

SQL - Static variable in class com.endeca.edf.adapter.plugins.JdbcAdapter

T

toArray() - Method in class com.endeca.edf.adapter.Record

Returns an array containing all of the pvals in this record, in proper sequence.

toString() - Method in class com.endeca.edf.adapter.AdapterConfig

Provides a user-readable string representation of this configuration.

toString() - Method in class com.endeca.edf.adapter.PVal

String representation of this PVal.

toString() - Method in class com.endeca.edf.adapter.Record

Provides a user-readable string representation of this record.

W

WebDAVPlugin - Class in com.endeca.edf.adapter.plugins

This pluggable adapter demonstrates how to connect to WebDAV using the Apache Slide API.

WebDAVPlugin() - Constructor for class com.endeca.edf.adapter.plugins.WebDAVPlugin

write(boolean) - Method in class com.endeca.edf.adapter.BinaryFormatOutputStream

write(int) - Method in class com.endeca.edf.adapter.BinaryFormatOutputStream

write(double) - Method in class com.endeca.edf.adapter.BinaryFormatOutputStream

write(String) - Method in class com.endeca.edf.adapter.BinaryFormatOutputStream

writePropName(String) - Method in class com.endeca.edf.adapter.BinaryFormatOutputStream

A B C D E F G H I J M N P R S T W