com.edustructures.sifworks.tools.mapping
Class OtherIdRule

java.lang.Object
  extended by com.edustructures.sifworks.tools.mapping.Rule
      extended by com.edustructures.sifworks.tools.mapping.OtherIdRule
All Implemented Interfaces:
java.io.Serializable

public class OtherIdRule
extends Rule
implements java.io.Serializable

A Rule class to evaluate <OtherId> queries as defined by the OtherIdMapping class.

Version:
1.0
See Also:
Serialized Form

Constructor Summary
OtherIdRule(OtherIdMapping mapping)
           
OtherIdRule(OtherIdMapping mapping, org.w3c.dom.Node node)
           
 
Method Summary
 Rule copy(FieldMapping newParent)
          Produces a duplicate of this Rule object
 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.
 java.lang.String toString()
          Return the string representation of this OtherIdRule as XML text
 void toXML(org.w3c.dom.Node parent)
          Render this OtherIdRule as an XML DOM Node
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OtherIdRule

public OtherIdRule(OtherIdMapping mapping)

OtherIdRule

public OtherIdRule(OtherIdMapping mapping,
                   org.w3c.dom.Node node)
Method Detail

copy

public Rule copy(FieldMapping newParent)
          throws ADKMappingException
Produces a duplicate of this Rule object

Specified by:
copy in class Rule
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 void toXML(org.w3c.dom.Node parent)
Render this OtherIdRule as an XML DOM Node

Specified by:
toXML in class Rule
Parameters:
parent - The parent Node

toString

public java.lang.String toString()
Return the string representation of this OtherIdRule as XML text

Overrides:
toString in class java.lang.Object

evaluate

public SIFSimpleType evaluate(SIFXPathContext xpathContext,
                              SIFVersion version)
                       throws ADKSchemaException
Description copied from class: Rule
Evaluates this rule against a SIFDataObject and returns the text value of the element or attribute that satisfied the query.

Specified by:
evaluate in class Rule
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


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.