org.marketcetera.ors.filters
Class FieldRemoverMessageModifier

java.lang.Object
  org.marketcetera.ors.filters.FieldRemoverMessageModifier

All Implemented Interfaces:

MessageModifier

public class FieldRemoverMessageModifier
extends Object
implements MessageModifier

Removes fields if present from FIX messages.

Since:

2.1.4

Version:

$Id: FieldRemoverMessageModifier.java 16154 2012-07-14 16:34:05Z colin $

Author:

Colin DuPlantis

Constructor Summary

FieldRemoverMessageModifier()
Create a new FieldRemoverMessageModifier instance.

FieldRemoverMessageModifier(String inField)
Create a new FieldRemoverMessageModifier instance.

Method Summary

int	getField() Get the field value.
String	getMsgType() Get the msgType value.
boolean	modifyMessage(Message inMessage, ReportHistoryServices inHistoryServices, FIXMessageAugmentor inAugmentor) Implement the function to make in-line modifications to the incoming message.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldRemoverMessageModifier

public FieldRemoverMessageModifier()

Create a new FieldRemoverMessageModifier instance.

FieldRemoverMessageModifier

public FieldRemoverMessageModifier(String inField)

Create a new FieldRemoverMessageModifier instance.

Parameters:

inField - a String value containing the field to remove in the form tag(msg-type)

Throws:

IllegalArgumentException - if the field specification is null or non-conforming

Method Detail

modifyMessage

public boolean modifyMessage(Message inMessage,
                             ReportHistoryServices inHistoryServices,
                             FIXMessageAugmentor inAugmentor)
                      throws CoreException

Description copied from interface: MessageModifier

Implement the function to make in-line modifications to the incoming message.

Specified by:

modifyMessage in interface MessageModifier

Parameters:

inMessage - the message to be modified

inAugmentor - FIX-version specific augmentor to apply to this message

Returns:

true if the modifier has modified the message, false otherwise

Throws:

CoreException

getMsgType

public String getMsgType()

Get the msgType value.

Returns:

a String value

getField

public int getField()

Get the field value.

Returns:

a int value

toString

public String toString()

Overrides:

toString in class Object