net.sf.jrtps.message.parameter

Class ContentFilterProperty

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

net.sf.jrtps.message.parameter.ContentFilterProperty

public class ContentFilterProperty
extends Parameter

ContentFilterProperty parameter is sent by reader to writer, so that writer side filtering is possible.

Author:

mcr70

Field Summary

Fields

Modifier and Type	Field and Description
static String	DDSSQL Filter class name defined by DDS specification.
static String	JAVA_FILTER_CLASS Filter class java

Constructor Summary

Constructors

Constructor and Description
ContentFilterProperty(String cfTopicName, String relatedTopicName, Class<? extends ContentFilter> cfClass) Constructor for ContentFilterProperty. filterClassName is set to 'java', filterExpression is set to fully qualified class name of the given class.
ContentFilterProperty(String cfTopicName, String relatedTopicName, String filterClassName, String filterExpression)
ContentFilterProperty(String cfTopicName, String relatedTopicName, String filterClassName, String filterExpression, String[] expressionParameters)

Method Summary

Modifier and Type	Method and Description
String	getContentFilteredTopicName() Gets name of the content filtered topic.
String[]	getExpressionParameters() Expression parameters used by filter expression
String	getFilterClassName() Name of filter class
String	getFilterExpression() Gets the filter expression.
byte[]	getRawSignature() Gets the signature as byte array
String	getRelatedTopicName() Gets the name of the related topic.
String	getSignature() Gets the filter signature.
void	read(RTPSByteBuffer bb, int length)
String	toString()
void	writeTo(RTPSByteBuffer bb) Writes this Parameter into given RTPSByteBuffer

Methods inherited from class net.sf.jrtps.message.parameter.Parameter

getBytes, getParameterId, readBytes, writeBytes

Methods inherited from class java.lang.Object

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

Field Detail

DDSSQL

public static final String DDSSQL

Filter class name defined by DDS specification.

See Also:

Constant Field Values

JAVA_FILTER_CLASS

public static final String JAVA_FILTER_CLASS

Filter class java

See Also:

Constant Field Values

Constructor Detail

ContentFilterProperty

public ContentFilterProperty(String cfTopicName,
                             String relatedTopicName,
                             Class<? extends ContentFilter> cfClass)

Constructor for ContentFilterProperty. filterClassName is set to 'java', filterExpression is set to fully qualified class name of the given class. expressionParameters is set to empty String array.

jRTPS writers recognize this type of filterClass, and tries to instantiate a ContentFilter with this className. If it succeeds, it is automatically registered to writer.

Parameters:

cfTopicName - Name of the topic

relatedTopicName - related topic name

cfClass - ContentFilter class

ContentFilterProperty

public ContentFilterProperty(String cfTopicName,
                             String relatedTopicName,
                             String filterClassName,
                             String filterExpression)

ContentFilterProperty

public ContentFilterProperty(String cfTopicName,
                             String relatedTopicName,
                             String filterClassName,
                             String filterExpression,
                             String[] expressionParameters)

Method Detail

getContentFilteredTopicName

public String getContentFilteredTopicName()

Gets name of the content filtered topic.

Returns:

name of the content filtered topic

getRelatedTopicName

public String getRelatedTopicName()

Gets the name of the related topic.

Returns:

name of the related topic

getFilterClassName

public String getFilterClassName()

Name of filter class

Returns:

name of the filter class

getFilterExpression

public String getFilterExpression()

Gets the filter expression.

Returns:

filter expression

getExpressionParameters

public String[] getExpressionParameters()

Expression parameters used by filter expression

Returns:

expression parameters

getSignature

public String getSignature()

Gets the filter signature. Filter signature is calculated as MD5 checksum of the fields of this ContentFilterProperty. If MD5 algorithm is not available on platform where application is being run, a null will be returned. In that case writer side content filtering is not possible.

Returns:

filter signature, or null if filter signature could not be calculated

getRawSignature

public byte[] getRawSignature()

Gets the signature as byte array

Returns:

signature

read

public void read(RTPSByteBuffer bb,
                 int length)

Specified by:

read in class Parameter

writeTo

public void writeTo(RTPSByteBuffer bb)

Description copied from class: Parameter

Writes this Parameter into given RTPSByteBuffer

Specified by:

writeTo in class Parameter

Parameters:

bb - RTPSByteBuffer

toString

public String toString()

Overrides:

toString in class Parameter