com.edustructures.sifworks.tools.mapping
Class Rule

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

Direct Known Subclasses:

OtherIdRule, XPathRule

public abstract class Rule
extends java.lang.Object

The abstract base class for all Mappings rules

Version:

1.0

Constructor Summary

Rule()

Method Summary

abstract Rule	copy(FieldMapping newParent) Produces a duplicate of this Rule object
abstract SIFSimpleType	evaluate(SIFXPathContext xpathContext, SIFVersion version) Evaluates this rule against a SIFDataObject and returns the text value of the element or attribute that satisfied the query.
abstract void	toXML(org.w3c.dom.Node parent) Render this Rule as an DOM Node

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule()

Method Detail

evaluate

public abstract SIFSimpleType evaluate(SIFXPathContext xpathContext,
                                       SIFVersion version)
                                throws ADKSchemaException

Evaluates this rule against a SIFDataObject and returns the text value of the element or attribute that satisfied the query.

Parameters:

xpathContext - The SIFXPathContext instance to use for object traversal

version - The SIF Version that is in effect

Returns:

The SimpleType representing the value of the element or attribute that satisfied the query, or null if no match found

Throws:

ADKSchemaException - If the xpath expression cannot be resolved

copy

public abstract Rule copy(FieldMapping newParent)
                   throws ADKMappingException

Produces a duplicate of this Rule object

Parameters:

newParent - The parent to copy this rule to

Returns:

A "deep copy" of this Rule object

Throws:

ADKMappingException - If the rule cannot be copied

toXML

public abstract void toXML(org.w3c.dom.Node parent)

Render this Rule as an DOM Node

Parameters:

parent - The parent Node