com.edustructures.sifworks.tools.mapping
Class OtherIdMapping

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

public class OtherIdMapping
extends java.lang.Object

Encapsulates an <OtherId> field mapping

Version:

ADK 1.0

Constructor Summary

OtherIdMapping(java.lang.String type, java.lang.String prefix)
Constructor

OtherIdMapping(java.lang.String type, java.lang.String prefix, org.w3c.dom.Node node)

Method Summary

OtherIdMapping	copy() Produces a duplicate of this Rule object
static OtherIdMapping	fromXML(ObjectMapping parent, FieldMapping field, org.w3c.dom.Element element)
java.lang.String	getPrefix() Gets the optional OtherId prefix string that must be present at the beginning of the OtherId value for this rule to evaluate true.
java.lang.String	getType() Gets the <OtherId> Type attribute value that must be present for this rule to evaluate true
void	setPrefix(java.lang.String prefix) Gets the optional OtherId prefix string that must be present at the beginning of the OtherId value for this rule to evaluate true.
void	setType(java.lang.String type) Sets the <OtherId> Type attribute value that must be present for this rule to evaluate true

Methods inherited from class java.lang.Object

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

Constructor Detail

OtherIdMapping

public OtherIdMapping(java.lang.String type,
                      java.lang.String prefix)

Constructor

Parameters:

type - The value of the OtherId/@Type attribute to match (e.g. 'ZZ')

prefix - The prefix value to match (e.g. 'GRADE:')

OtherIdMapping

public OtherIdMapping(java.lang.String type,
                      java.lang.String prefix,
                      org.w3c.dom.Node node)

Method Detail

copy

public OtherIdMapping copy()

Produces a duplicate of this Rule object

Returns:

A "deep copy" of this Rule object

fromXML

public static OtherIdMapping fromXML(ObjectMapping parent,
                                     FieldMapping field,
                                     org.w3c.dom.Element element)
                              throws ADKConfigException

Throws:

ADKConfigException

setType

public void setType(java.lang.String type)

Sets the <OtherId> Type attribute value that must be present for this rule to evaluate true

Parameters:

type - The value of the Type attribute that must be present for this rule to evaluate true (e.g. "ZZ", "06", etc.)

getType

public java.lang.String getType()

Gets the <OtherId> Type attribute value that must be present for this rule to evaluate true

Returns:

The value of the Type attribute that must be present for this rule to evaluate true (e.g. "ZZ", "06", etc.)

setPrefix

public void setPrefix(java.lang.String prefix)

Gets the optional OtherId prefix string that must be present at the beginning of the OtherId value for this rule to evaluate true. Prefix strings are not officially part of the SIF 1.0 specification but are typically agreed upon by vendors and used with Type "ZZ" (e.g. <OtherId Type="ZZ">GRADE:8</OtherId>)

Parameters:

a - prefix string agreed upon by two or more agents to identify multiple <OtherId> instances (e.g. "HOMEROOM:", "BARCODE:", "GRADE:", etc.)

getPrefix

public java.lang.String getPrefix()

Gets the optional OtherId prefix string that must be present at the beginning of the OtherId value for this rule to evaluate true.

Returns:

The prefix string agreed upon by two or more agents to identify multiple <OtherId> instances (e.g. "HOMEROOM:", "BARCODE:", "GRADE:", etc.)