org.dlese.dpc.standards.asn

Class AsnStandard

java.lang.Object

org.dlese.dpc.standards.asn.AsnStandard

Direct Known Subclasses:

AAASBenchmark, AsnMappingStandard, ColoradoBenchmark, RootAsnStandard

public class AsnStandard
extends java.lang.Object

Wraps AsnStatement to expose object based hierarchy information, such as "children" and "ancestors" as AsnStandards rather than ASN IDs, and to expose resolved ASN purl-based Attributes as human-readable strings, such as "Science" rather than "http://purl.org/ASN/scheme/ASNTopic/science".

Author:

Jonathan Ostwald

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List	ancestors
protected AsnDocument	asnDoc
protected java.util.List	children

Constructor Summary

Constructors

Constructor and Description
AsnStandard(AsnStatement asnStmnt, AsnDocument asnDoc) Constructor for the AsnStandard object given an XML Element and the containing AsnDocument instance;

Method Summary

Modifier and Type	Method and Description
protected void	addChild(AsnStandard std) Adds a Child to the AsnStandard object
java.util.List	getAncestors() Gets the ancestors attribute of the AsnStandard object
AsnStatement	getAsnStatement()
java.lang.String	getAuthor() Gets the author attribute of the AsnStandard object
java.util.List	getChildren() Returns children as AsnStandard instances in same order as the XML Element defining this Standard
java.lang.String	getDescription()
java.lang.String	getDisplayText() Walk the ancestor list, adding text from each node
java.lang.String	getDocumentIdentifier() Gets the documentIdentifier attribute of the AsnStandard object
int	getEndGradeLevel() Gets the endGradeLevel attribute of the AsnStandard object
java.lang.String	getGradeRange()
java.lang.String	getId()
int	getLevel() Gets the level attribute of the AsnStandard object
java.lang.String	getParentId()
AsnStandard	getParentStandard() Gets the parentStandard attribute of the AsnStandard object
int	getStartGradeLevel() Gets the startGradeLevel attribute of the AsnStandard object
protected AsnStandard	getStd(java.lang.String id) Gets the std attribute of the AsnStandard object
AsnDocument	getStdDocument()
java.lang.String	getTopic() Gets the topic attribute of the AsnStandard object
boolean	isLeaf() Returns true if the AsnStandard object is a leaf
static java.lang.String	removeEntityRefs(java.lang.String in) Removes entityRefs from the provided string
java.lang.String	toString() NOT YET DOCUMENTED

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

asnDoc

protected AsnDocument asnDoc

children

protected java.util.List children

ancestors

protected java.util.List ancestors

Constructor Detail

AsnStandard

public AsnStandard(AsnStatement asnStmnt,
                   AsnDocument asnDoc)

Constructor for the AsnStandard object given an XML Element and the containing AsnDocument instance;

Parameters:

e - the element defining the AsnStandard

asnDoc - the Document containing this standard

Method Detail

getStdDocument

public AsnDocument getStdDocument()

getAsnStatement

public AsnStatement getAsnStatement()

getDescription

public java.lang.String getDescription()

getId

public java.lang.String getId()

getGradeRange

public java.lang.String getGradeRange()

getDocumentIdentifier

public java.lang.String getDocumentIdentifier()

Gets the documentIdentifier attribute of the AsnStandard object

Returns:

The documentIdentifier value

getStd

protected AsnStandard getStd(java.lang.String id)

Gets the std attribute of the AsnStandard object

Parameters:

id - Description of the Parameter

Returns:

The std value

getAuthor

public java.lang.String getAuthor()

Gets the author attribute of the AsnStandard object

Returns:

The author value

getTopic

public java.lang.String getTopic()

Gets the topic attribute of the AsnStandard object

Returns:

The topic value

isLeaf

public boolean isLeaf()

Returns true if the AsnStandard object is a leaf

Returns:

The leaf value

getChildren

public java.util.List getChildren()

Returns children as AsnStandard instances in same order as the XML Element defining this Standard

Returns:

The children value

addChild

protected void addChild(AsnStandard std)

Adds a Child to the AsnStandard object

Parameters:

std - The feature to be added to the Child attribute

getStartGradeLevel

public int getStartGradeLevel()

Gets the startGradeLevel attribute of the AsnStandard object

Returns:

The startGradeLevel value

getEndGradeLevel

public int getEndGradeLevel()

Gets the endGradeLevel attribute of the AsnStandard object

Returns:

The endGradeLevel value

getParentId

public java.lang.String getParentId()

getParentStandard

public AsnStandard getParentStandard()

Gets the parentStandard attribute of the AsnStandard object

Returns:

The parentStandard value

removeEntityRefs

public static java.lang.String removeEntityRefs(java.lang.String in)

Removes entityRefs from the provided string

Parameters:

in - input string

Returns:

string with entity refs removed

getDisplayText

public java.lang.String getDisplayText()

Walk the ancestor list, adding text from each node

Returns:

The displayText value

getAncestors

public java.util.List getAncestors()

Gets the ancestors attribute of the AsnStandard object

Returns:

The ancestors value

getLevel

public int getLevel()

Gets the level attribute of the AsnStandard object

Returns:

The level value

toString

public java.lang.String toString()

NOT YET DOCUMENTED

Overrides:

toString in class java.lang.Object

Returns:

NOT YET DOCUMENTED