com.edustructures.sifworks.tools.mapping
Class MappingsFilter

java.lang.Object
  com.edustructures.sifworks.tools.mapping.MappingsFilter

public class MappingsFilter
extends java.lang.Object

Encapsulates optional filtering attributes for field mapping rules.

A field mapping rule can define any of the following filters:

• SIF Version. The rule will only be applied if the SIFVersion instance passed to the Mappings.map method matches this value. The version filter is a string comprised of a comparison operator ("=" for equals, "-" for Less Than or Equal To, or "+" for Greater Than or Equal To) followed by a SIF Version identifier. For example, "=1.5" matches SIF 1.5; "+1.1" matches all versions of SIF equal to and greater than 1.1; and "-1.1" matches all versions of SIF less than or equal to SIF 1.1. Filter on SIF Version to map values to version-specific elements or attributes of SIF Data Objects.
• Direction. The rule will only be applied if the Direction flag (MappingsDirection.INBOUND or MappingsDirection.OUTBOUND) passed to the Mappings.map method matches this value. Filter on Direction to create field mapping rules that differ for inbound messages like SIF_Request than for outbound messages like SIF_Event and SIF_Response.

Constructor Summary

MappingsFilter()

Method Summary

boolean	evalDirection(MappingsDirection flag) Evaluates the Message Direction filter against a direction flag.
boolean	evalVersion(SIFVersion version) Evaluates the SIF Version filter against a SIFVersion instance.
MappingsDirection	getDirection() Gets the Message Direction filter.
java.lang.String	getSIFVersion() Gets the SIF Version filter.
boolean	hasDirectionFilter() Determines if the Message Direction filter is specified
boolean	hasVersionFilter() Determines if the SIF Version filter is specified
void	setDirection(MappingsDirection dir) Sets the Message Direction filter.
void	setSIFVersion(java.lang.String version) Sets the SIF Version filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingsFilter

public MappingsFilter()

Method Detail

setSIFVersion

public void setSIFVersion(java.lang.String version)

Sets the SIF Version filter.

Parameters:

version - A SIF Version string prefixed by a comparision operator "=", "+" or "-";. For example, specify "=1.5" to match SIF 1.5; "+1.1" to match all versions of SIF equal to or greater than 1.1, "-1.1" to match all versions of SIF less than or equal to SIF 1.1, etc. If no comparision operator is specified Equal To ("=") is assumed.

getSIFVersion

public java.lang.String getSIFVersion()

Gets the SIF Version filter.

Returns:

A SIF Version string prefixed by a comparision operator "=", "<" or ">";. For example, specify "=1.5" to match SIF 1.5; ">1.1" to match all versions of SIF equal to or greater than 1.1, etc. If no comparision operator is specified Equal To ("=") is assumed.

hasVersionFilter

public boolean hasVersionFilter()

Determines if the SIF Version filter is specified

Returns:

True if this filter contains a SIF Version filter.

setDirection

public void setDirection(MappingsDirection dir)

Sets the Message Direction filter.

Parameters:

dir - Any MappingsDirection. constant

getDirection

public MappingsDirection getDirection()

Gets the Message Direction filter.

Returns:

Any MappingsDirection. constant

hasDirectionFilter

public boolean hasDirectionFilter()

Determines if the Message Direction filter is specified

Returns:

True if this filter specifies a direction filter

evalDirection

public boolean evalDirection(MappingsDirection flag)

Evaluates the Message Direction filter against a direction flag.

Parameters:

flag - Any MappingsDirection value

Returns:

true If the message direction filter is undefined or matches the specified flag flag

evalVersion

public boolean evalVersion(SIFVersion version)

Evaluates the SIF Version filter against a SIFVersion instance.

Parameters:

version - A SIFVersion instance

Returns:

true If the SIF Version filter is undefined, or if the version parameter evaluates true given the comparision operator and version of SIF specified by the current filter