com.edustructures.sifworks
Interface DTD

All Known Implementing Classes:

SIFDTD

public interface DTD

Classes that implement the DTD interface provide information about the schema of elements and attributes. For example, the SIFDTD class implements this interface to define all elements comprising the Schools Interoperability Framework.

Version:

ADK 1.0

Method Summary

java.lang.String	getElementTag(byte type) Gets the element tag corresponding to a type ID
byte	getElementType(java.lang.String name) Gets the type ID corresponding to an element tag name
SIFFormatter	getFormatter(SIFVersion version)
java.lang.String	getNamespace(SIFVersion version) Gets the namespace associated with this DTD
ElementDef	lookupElementDef(ElementDef parent, java.lang.String childTag) Lookup an ElementDef object describing an element or attribute
ElementDef	lookupElementDef(java.lang.String key) Lookup an ElementDef object describing an element or attribute

Method Detail

lookupElementDef

ElementDef lookupElementDef(java.lang.String key)

Lookup an ElementDef object describing an element or attribute

Parameters:

key - The name of the element in the form "parent_field", where parent is the name of the parent element and field is the name of the child element or attribute (e.g. "SIF_Ack_SIF_Header", "StudentPersonal_Name", etc.)

Returns:

The ElementDef that provides metadata about the requested element or null if not found

lookupElementDef

ElementDef lookupElementDef(ElementDef parent,
                            java.lang.String childTag)

Lookup an ElementDef object describing an element or attribute

Parameters:

parent - The parent ElementDef

childTag - the name of the child element

Returns:

The ElementDef that provides metadata about the requested element or null if not found

getNamespace

java.lang.String getNamespace(SIFVersion version)

Gets the namespace associated with this DTD

Parameters:

version - The SIF Version

Returns:

The namespace (e.g. the "xmlns" value for SIF_Messages)

getFormatter

SIFFormatter getFormatter(SIFVersion version)

getElementTag

java.lang.String getElementTag(byte type)

Gets the element tag corresponding to a type ID

Parameters:

type - A type identifier defined by the class that implements this interface (e.g. SIFDTD.MSGTYP_PROVIDE)

Returns:

The tag name of the element (e.g. "SIF_Provide")

getElementType

byte getElementType(java.lang.String name)

Gets the type ID corresponding to an element tag name

Parameters:

name - The tag name of an element (e.g. "SIF_Provide")

Returns:

A type identifier defined by the class that implements this interface (e.g. SIFDTD.MSGTYP_PROVIDE)