oracle.ecsf
Interface Attachment

public interface Attachment

An attachment is a document that is associated to an IndexableDocument. It is indexed as part of the indexable document. Blob or Clob columns are normally treated as attachements.

Field Summary

static java.lang.String	ATTACHMENT_CLASS
static java.lang.String	COLUMN_NAME
static java.lang.String	DATA_TYPE_NAME
static java.lang.String	KEY_COUNT
static java.lang.String	KEY_NAME_PREFIX
static java.lang.String	KEY_VALUE_PREFIX
static java.lang.String	SCHEMA_NAME
static java.lang.String	TABLE_NAME

Method Summary

java.util.Map	getParameters() Returns configuration parameters that will be used to retrieve the attachment.
PrimaryKey	getPrimaryKey() Returns the primary key for the attachment.
java.lang.String	getType() Returns Mime type of this attachment.
void	initialize(SearchContext ctx, java.util.Map parameters, PrimaryKey pk) This method is called to initialize this the object before read method is called.
void	read(SearchContext ctx, java.io.OutputStream out) Reads the attachment.

Field Detail

ATTACHMENT_CLASS

static final java.lang.String ATTACHMENT_CLASS

See Also:

Constant Field Values

TABLE_NAME

static final java.lang.String TABLE_NAME

See Also:

Constant Field Values

COLUMN_NAME

static final java.lang.String COLUMN_NAME

See Also:

Constant Field Values

SCHEMA_NAME

static final java.lang.String SCHEMA_NAME

See Also:

Constant Field Values

DATA_TYPE_NAME

static final java.lang.String DATA_TYPE_NAME

See Also:

Constant Field Values

KEY_COUNT

static final java.lang.String KEY_COUNT

See Also:

Constant Field Values

KEY_NAME_PREFIX

static final java.lang.String KEY_NAME_PREFIX

See Also:

Constant Field Values

KEY_VALUE_PREFIX

static final java.lang.String KEY_VALUE_PREFIX

See Also:

Constant Field Values

Method Detail

getType

java.lang.String getType()

Returns Mime type of this attachment. This value is advisory. The consumer might detect the mime type.

getParameters

java.util.Map getParameters()

Returns configuration parameters that will be used to retrieve the attachment. These name value paires are used to form URL.

Returns:

configuration parameters. You must return empty map if nothing needed.

getPrimaryKey

PrimaryKey getPrimaryKey()

Returns the primary key for the attachment. Information can be used to identify the attachment, in form of PrimaryKey.

Returns:

primary key value for the attachment.

initialize

void initialize(SearchContext ctx,
                java.util.Map parameters,
                PrimaryKey pk)

This method is called to initialize this the object before read method is called. The implementor must set internal status ready for read operation.

Parameters:

ctx - search context.

parameters - configuration parameters.

pk - primary key value.

read

void read(SearchContext ctx,
          java.io.OutputStream out)

Reads the attachment. The implementor is responsible to write the attachment to the output stream provided.

Parameters:

ctx - runtim search context.

out - output stream to write the attachment.