com.google.enterprise.adaptor

Interface MetadataTransform

All Known Implementing Classes:

AddContentTypeToMetadata, CommandLineTransform, DateSplitTransform, FilterMimetypes, MetadataTransform.HistoricalWrapper, MetadataTransformExample, SkipDocumentFilter

public interface MetadataTransform

Represents an individual transform in the transform pipeline.

Implementations should also typically have a static factory method with a single Map<String, String> argument for creating instances based on configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetadataTransform.HistoricalWrapper Versions prior to 4.1.1 used class named "DocumentTransform".
static class	MetadataTransform.TransmissionDecision Transforms can cancel sending doc, or cancel sending its contents.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CONTENT_TYPE
static String	KEY_CRAWL_ONCE
static String	KEY_DISPLAY_URL
static String	KEY_DOC_ID
static String	KEY_LAST_MODIFIED_MILLIS_UTC
static String	KEY_LOCK
static String	KEY_TRANSMISSION_DECISION

Method Summary

Modifier and Type	Method and Description
void	transform(Metadata metadata, Map<String,String> params) Any changes to metadata and params will be passed on to subsequent transforms.

Field Detail

KEY_DOC_ID

static final String KEY_DOC_ID

See Also:

Constant Field Values

KEY_DISPLAY_URL

static final String KEY_DISPLAY_URL

See Also:

Constant Field Values

KEY_CONTENT_TYPE

static final String KEY_CONTENT_TYPE

See Also:

Constant Field Values

KEY_CRAWL_ONCE

static final String KEY_CRAWL_ONCE

See Also:

Constant Field Values

KEY_LOCK

static final String KEY_LOCK

See Also:

Constant Field Values

KEY_LAST_MODIFIED_MILLIS_UTC

static final String KEY_LAST_MODIFIED_MILLIS_UTC

See Also:

Constant Field Values

KEY_TRANSMISSION_DECISION

static final String KEY_TRANSMISSION_DECISION

See Also:

Constant Field Values

Method Detail

transform

void transform(Metadata metadata,
               Map<String,String> params)

Any changes to metadata and params will be passed on to subsequent transforms. This method must be thread-safe.

Parameters:

metadata - of document

params - are extra contextual information