cgl.narada.wsinfra.wse.matching
Class MatchingCapability

java.lang.Object
  cgl.narada.wsinfra.wse.matching.MatchingCapability

Direct Known Subclasses:

RegularExpressionMatchingCapability, TopicMatchingCapability, XPathMatchingCapability, XQueryMatchingCapability

public abstract class MatchingCapability
extends Object

This is an interface which snapshots the capability of matching. Users can develop their custom engines and register these at run-time. For e.g. there could implementations of this for XPath, XQuery, String Topics and Regular Expressions. Other custom capabilities can be added by the developers and registered at run-time.

Constructor Summary

MatchingCapability()

Method Summary

void	checkEnvelopeForProblems(EnvelopeDocument envelopeDocument) Checks the envelope document for problems.
String	checkFilterForProblems(FilterType filter) Checks the filter for problems and returns the constraint associated with this filter.
abstract String	getCapabilityName() Retrieves the name associated with this capability.
abstract String	getDialect() Retrieves the dialects associated with the matching capability
abstract boolean	performMatching(EnvelopeDocument envelopeDocument, FilterType filter) Perform the matching operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchingCapability

public MatchingCapability()

Method Detail

getDialect

public abstract String getDialect()

Retrieves the dialects associated with the matching capability

getCapabilityName

public abstract String getCapabilityName()

Retrieves the name associated with this capability.

performMatching

public abstract boolean performMatching(EnvelopeDocument envelopeDocument,
                                        FilterType filter)
                                 throws ProcessingException

Perform the matching operation.

Returns:

true If there is a match

Throws:

ProcessingException

checkEnvelopeForProblems

public void checkEnvelopeForProblems(EnvelopeDocument envelopeDocument)
                              throws ProcessingException

Checks the envelope document for problems.

Throws:

ProcessingException

checkFilterForProblems

public String checkFilterForProblems(FilterType filter)
                              throws ProcessingException

Checks the filter for problems and returns the constraint associated with this filter.

Throws:

ProcessingException