MetadataTransform

All Known Implementing Classes:

AddContentTypeToMetadata, CommandLineTransform, DateFilter, DateSplitTransform, FilterMimetypes, MetadataTransform.HistoricalWrapper, MetadataTransformExample, RegexFilter, 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.Keyset` Identifies the location a configured key/value pair resides, either in the `Metadata`, or the map of `params` supplied to the `transform` method of a `MetadataTransform`.
`static class`	`MetadataTransform.TransmissionDecision` Transforms can cancel sending a document, or cancel sending its contents by adding a `Transmission-Decision` to the `Map` of `params` supplied to the `transform` method of the `MetadataTransform`.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_CONTENT_TYPE` The key for the document's content type supplied in the `params`.
`static String`	`KEY_CRAWL_ONCE` The key for the document's crawl once flag supplied in the `params`.
`static String`	`KEY_DISPLAY_URL` The key for the document's display URL supplied in the `params`.
`static String`	`KEY_DOC_ID` The key for the document's unique ID supplied in the `params`.
`static String`	`KEY_FORCED_TRANSMISSION_DECISION`
`static String`	`KEY_LAST_MODIFIED_MILLIS_UTC` The key for the document's last modified timestamp supplied in the `params`.
`static String`	`KEY_LOCK` The key for the document's lock flag supplied in the `params`.
`static String`	`KEY_TRANSMISSION_DECISION` The key for a `MetadataTransform.TransmissionDecision` that may be added to the `params`.

Method Summary

All Methods Instance Methods Abstract Methods
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
```
    The key for the document's unique ID supplied in the params.
    
    See Also:
    
    Constant Field Values
  - KEY_DISPLAY_URL
```
static final String KEY_DISPLAY_URL
```
    The key for the document's display URL supplied in the params.
    
    See Also:
    
    Constant Field Values
  - KEY_CONTENT_TYPE
```
static final String KEY_CONTENT_TYPE
```
    The key for the document's content type supplied in the params.
    
    See Also:
    
    Constant Field Values
  - KEY_CRAWL_ONCE
```
static final String KEY_CRAWL_ONCE
```
    The key for the document's crawl once flag supplied in the params.
    
    See Also:
    
    Constant Field Values
  - KEY_LOCK
```
static final String KEY_LOCK
```
    The key for the document's lock flag supplied in the params.
    
    See Also:
    
    Constant Field Values
  - KEY_LAST_MODIFIED_MILLIS_UTC
```
static final String KEY_LAST_MODIFIED_MILLIS_UTC
```
    The key for the document's last modified timestamp supplied in the params.
    
    See Also:
    
    Constant Field Values
  - KEY_TRANSMISSION_DECISION
```
static final String KEY_TRANSMISSION_DECISION
```
    The key for a MetadataTransform.TransmissionDecision that may be added to the params.
    
    See Also:
    
    Constant Field Values
  - KEY_FORCED_TRANSMISSION_DECISION
```
static final String KEY_FORCED_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

Interface MetadataTransform

Nested Class Summary

Field Summary

Method Summary

Field Detail

KEY_DOC_ID

KEY_DISPLAY_URL

KEY_CONTENT_TYPE

KEY_CRAWL_ONCE

KEY_LOCK

KEY_LAST_MODIFIED_MILLIS_UTC

KEY_TRANSMISSION_DECISION

KEY_FORCED_TRANSMISSION_DECISION

Method Detail

transform