RecordProcessor

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable
```
public interface RecordProcessor
extends java.lang.Cloneable, java.io.Serializable
```
Processes a record. A RecordProcessor may have filters to allow processing of records matching given criteria. It also gives users fine management of record's attributes to be processed.

Since:

8-Dec-2007

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addFilter(RecordFilter filter)` Adds a `RecordFilter` to the processor
`java.lang.Object`	`clone()` RecordFilters must override Object.clone()
`java.util.List<RecordFilter>`	`getFilters()` Gets the currently configured `RecordFilter` instances
`java.lang.String`	`getName()` Returns the current RecordProcessor name
`boolean`	`isProcessDate()` Return whether the date data are being processed
`boolean`	`isProcessDestinationHost()` Return whether the destination host data are being processed
`boolean`	`isProcessEnvelope()` Return whether the envelope data are being processed
`boolean`	`isProcessHeaders()` Return whether the headers data are being processed
`boolean`	`isProcessMessageType()` Return whether the message type data are being processed
`boolean`	`isProcessOperation()` Return whether the operation data are being processed
`boolean`	`isProcessSourceHost()` Return whether the source host data are being processed
`boolean`	`isRecording()` Return true when the record processor is configured for actively recording data; false otherwise
`void`	`processRecord(Record record)` Processes a `Record` instance
`void`	`setFilters(java.util.List<RecordFilter> filters)` Sets the `RecordFilter` instances for the current processor
`void`	`setName(java.lang.String name)` Sets the record processor name
`void`	`setProcessDate(boolean value)` Enable / disable processing of date
`void`	`setProcessDestinationHost(boolean value)` Enable / disable processing of destination host
`void`	`setProcessEnvelope(boolean value)` Enable / disable processing of envelope
`void`	`setProcessHeaders(boolean value)` Enable / disable processing of headers
`void`	`setProcessMessageType(boolean value)` Enable / disable processing of message type
`void`	`setProcessOperation(boolean value)` Enable / disable processing of operation
`void`	`setProcessSourceHost(boolean value)` Enable / disable processing of source host
`void`	`setRecording(boolean value)` Enable / disable actual data recording

- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the current RecordProcessor name
    
    Returns:
    
    the name
  - setName
```
void setName(java.lang.String name)
```
    Sets the record processor name
    
    Parameters:
    
    name - the name to set
  - isRecording
```
boolean isRecording()
```
    Return true when the record processor is configured for actively recording data; false otherwise
    
    Returns:
    
    a boolean specifying if the recording is on
  - setRecording
```
void setRecording(boolean value)
```
    Enable / disable actual data recording
    
    Parameters:
    
    value - true to enable recording, false to disable it
  - processRecord
```
void processRecord(Record record)
```
    Processes a Record instance
    
    Parameters:
    
    record - the Record to process
  - getFilters
```
java.util.List<RecordFilter> getFilters()
```
    Gets the currently configured RecordFilter instances
    
    Returns:
    
    the currently configured RecordFilter instances
  - addFilter
```
void addFilter(RecordFilter filter)
```
    Adds a RecordFilter to the processor
    
    Parameters:
    
    filter - the RecordFilter instance to add
  - setFilters
```
void setFilters(java.util.List<RecordFilter> filters)
```
    Sets the RecordFilter instances for the current processor
    
    Parameters:
    
    filters - the RecordFilter instances to set
  - isProcessSourceHost
```
boolean isProcessSourceHost()
```
    Return whether the source host data are being processed
    
    Returns:
    
    true if source host data are being processed, false otherwise
  - setProcessSourceHost
```
void setProcessSourceHost(boolean value)
```
    Enable / disable processing of source host
    
    Parameters:
    
    value - true to enable processing, false to disable it
  - isProcessDestinationHost
```
boolean isProcessDestinationHost()
```
    Return whether the destination host data are being processed
    
    Returns:
    
    true if destination host data are being processed, false otherwise
  - setProcessDestinationHost
```
void setProcessDestinationHost(boolean value)
```
    Enable / disable processing of destination host
    
    Parameters:
    
    value - true to enable processing, false to disable it
  - isProcessMessageType
```
boolean isProcessMessageType()
```
    Return whether the message type data are being processed
    
    Returns:
    
    true if message type data are being processed, false otherwise
  - setProcessMessageType
```
void setProcessMessageType(boolean value)
```
    Enable / disable processing of message type
    
    Parameters:
    
    value - true to enable processing, false to disable it
  - isProcessEnvelope
```
boolean isProcessEnvelope()
```
    Return whether the envelope data are being processed
    
    Returns:
    
    true if envelope data are being processed, false otherwise
  - setProcessEnvelope
```
void setProcessEnvelope(boolean value)
```
    Enable / disable processing of envelope
    
    Parameters:
    
    value - true to enable processing, false to disable it
  - isProcessHeaders
```
boolean isProcessHeaders()
```
    Return whether the headers data are being processed
    
    Returns:
    
    true if headers data are being processed, false otherwise
  - setProcessHeaders
```
void setProcessHeaders(boolean value)
```
    Enable / disable processing of headers
    
    Parameters:
    
    value - true to enable processing, false to disable it
  - isProcessOperation
```
boolean isProcessOperation()
```
    Return whether the operation data are being processed
    
    Returns:
    
    true if operation data are being processed, false otherwise
  - setProcessOperation
```
void setProcessOperation(boolean value)
```
    Enable / disable processing of operation
    
    Parameters:
    
    value - true to enable processing, false to disable it
  - isProcessDate
```
boolean isProcessDate()
```
    Return whether the date data are being processed
    
    Returns:
    
    true if date data are being processed, false otherwise
  - setProcessDate
```
void setProcessDate(boolean value)
```
    Enable / disable processing of date
    
    Parameters:
    
    value - true to enable processing, false to disable it
  - clone
```
java.lang.Object clone()
                throws java.lang.CloneNotSupportedException
```
    RecordFilters must override Object.clone()
    
    Returns:
    
    object
    
    Throws:
    
    java.lang.CloneNotSupportedException - exception

Interface RecordProcessor

Method Summary

Method Detail

getName

setName

isRecording

setRecording

processRecord

getFilters

addFilter

setFilters

isProcessSourceHost

setProcessSourceHost

isProcessDestinationHost

setProcessDestinationHost

isProcessMessageType

setProcessMessageType

isProcessEnvelope

setProcessEnvelope

isProcessHeaders

setProcessHeaders

isProcessOperation

setProcessOperation

isProcessDate

setProcessDate

clone