com.ibm.mq.headers.pcf

Class MQCFSF

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.headers.internal.Header
com.ibm.mq.headers.pcf.PCFHeader
com.ibm.mq.headers.pcf.PCFParameter
com.ibm.mq.headers.pcf.PCFFilterParameter
com.ibm.mq.headers.pcf.MQCFSF

All implemented interfaces:

public class MQCFSF
extends PCFFilterParameter

MQCFSF (PCF string filter parameter) header class.

        struct tagMQCFSF {
                MQLONG  Type;               // Structure type
                MQLONG  StrucLength;        // Structure length
                MQLONG  Parameter;          // Parameter identifier
                MQLONG  Operator;           // Operator identifier
                MQLONG  CodedCharSetId;     // Coded character set identifier
                MQLONG  FilterValueLength;  // Filter value length
                MQCHAR  FilterValue[1];     // Filter value -- first character
        };

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader
`MQHeader.Field`

Field Summary

Fields inherited from class com.ibm.mq.headers.internal.Header
`DEFAULT_CCSID, DEFAULT_ENCODING`

Fields inherited from class com.ibm.mq.jmqi.JmqiObject
`COMP_JM, COMP_JN, COMP_JO`

Constructor Summary

Constructor and Description
`MQCFSF()` Constructs an MQCFSF instance with default field values.
`MQCFSF(java.io.DataInput message)` Constructs an MQCFSF instance populated from an MQMessage.
`MQCFSF(java.io.DataInput message,int encoding,int characterSet)` Constructs an MQCFSF instance populated from a DataInput source.
`MQCFSF(int parameter,int operator,java.lang.String filterValue)` Initializes an MQCFSF with the specified values.

Method Summary

Modifier and Type	Method and Description
int	`getCodedCharSetId()` gets the coded character set identifier
java.lang.String	`getFilterValue()` gets the filter value
int	`getFilterValueLength()` gets the filter value length
int	`getOperator()` gets the operator identifier
int	`getParameter()` gets the parameter identifier
java.lang.String	`getStringValue()`
int	`getStrucLength()` Get the length of the structure.
int	`getType()` gets the structure type
java.lang.Object	`getValue()`
void	`setCodedCharSetId(int value)` sets the coded character set identifier
void	`setFilterValue(java.lang.String value)` sets the filter value
void	`setOperator(int value)` sets the operator identifier
void	`setParameter(int value)` sets the parameter identifier

Methods inherited from class com.ibm.mq.headers.pcf.PCFFilterParameter
`equals, getHeaderVersion, hashCode`

Methods inherited from class com.ibm.mq.headers.pcf.PCFParameter
`getParameterName, nextParameter`

Methods inherited from class com.ibm.mq.headers.internal.Header
`characterSet, encoding, fields, getBytesValue, getCharValue, getCharValue, getIntValue, getJmqiEnv, getStringValue, getValue, headerType, read, read, read, setBytesValue, setCharValue, setCharValue, setIntValue, setStringValue, setValue, size, store, store, toString, type, validate, write, write`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

MQCFSF

public MQCFSF()

Constructs an MQCFSF instance with default field values.

MQCFSF

public MQCFSF(java.io.DataInput message)
throws MQDataException
java.io.IOException

Constructs an MQCFSF instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

MQDataException - if the message content does not yield a valid MQCFSF stucture

java.io.IOException - if there is a problem reading the message content

MQCFSF

public MQCFSF(java.io.DataInput message,
int encoding,
int characterSet)
throws MQDataException
java.io.IOException

Constructs an MQCFSF instance populated from a DataInput source.

Parameters:

message - the MQMessage or other DataInput source to read

encoding - the initial numeric encoding of the data in the message

characterSet - the initial CCSID of the data in the message

Throws:

MQDataException - if the message content does not yield a valid MQCFSF stucture

java.io.IOException - if there is a problem reading the message content

MQCFSF

public MQCFSF(int parameter,
int operator,
java.lang.String filterValue)

Initializes an MQCFSF with the specified values.

Parameters:

parameter - the parameter identifier

filterValue - the string filter value

Method Detail

getType

public int getType()

gets the structure type

Specified by:

getType in class PCFHeader

Returns:

the structure type

getStrucLength

public int getStrucLength()

Get the length of the structure.

Returns:

the structure length.

getParameter

public int getParameter()

gets the parameter identifier

Specified by:

getParameter in class PCFParameter

Returns:

the parameter identifier

setParameter

public void setParameter(int value)

sets the parameter identifier

Parameters:

value - the parameter identifier

getOperator

public int getOperator()

gets the operator identifier

Specified by:

getOperator in class PCFFilterParameter

Returns:

the operator identifier

setOperator

public void setOperator(int value)

sets the operator identifier

Parameters:

value - the operator identifier

getCodedCharSetId

public int getCodedCharSetId()

gets the coded character set identifier

Returns:

the coded character set identifier

setCodedCharSetId

public void setCodedCharSetId(int value)

sets the coded character set identifier

Parameters:

value - the coded character set identifier

getFilterValueLength

public int getFilterValueLength( )

gets the filter value length

Returns:

the filter value length

getFilterValue

public java.lang.String getFilterValue( )

gets the filter value

Returns:

the filter value

setFilterValue

public void setFilterValue(java.lang.String value)

sets the filter value

Parameters:

value - the filter value

getValue

public java.lang.Object getValue( )

Description copied from class: PCFParameter

gets the parameter value

Specified by:

getValue in class PCFParameter

Returns:

the parameter value

getStringValue

public java.lang.String getStringValue( )

Description copied from class: PCFParameter

gets the parameter value as a String

Specified by:

getStringValue in class PCFParameter

Returns:

the parameter value as a String