edu.uci.isr.xarch.instance
Interface IXMLLink

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

XMLLinkImpl

public interface IXMLLink

extends IXArchElement

Interface for accessing objects of the XMLLink xsi:type in the instance namespace.

Author:

Automatically generated by xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Method Summary

void	clearHref() Remove the href attribute from this XMLLink.
void	clearType() Remove the type attribute from this XMLLink.
String	getHref() Get the href attribute from this XMLLink.
String	getType() Get the type attribute from this XMLLink.
boolean	hasHref(String href) Determine if the href attribute on this XMLLink has the given value.
boolean	hasType(String type) Determine if the type attribute on this XMLLink has the given value.
boolean	isEquivalent(IXMLLink XMLLinkToCheck) Determine if another XMLLink is equivalent to this one, ignoring ID's.
void	setHref(String href) Set the href attribute on this XMLLink.
void	setType(String type) Set the type attribute on this XMLLink.

Methods inherited from interface edu.uci.isr.xarch.IXArchElement

cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

setType

public void setType(String type)

Set the type attribute on this XMLLink.

Parameters:

type - type

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearType

public void clearType()

Remove the type attribute from this XMLLink.

getType

public String getType()

Get the type attribute from this XMLLink. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

type on this XMLLink

hasType

public boolean hasType(String type)

Determine if the type attribute on this XMLLink has the given value.

Parameters:

type - Attribute value to compare

Returns:

true if they match; false otherwise.

setHref

public void setHref(String href)

Set the href attribute on this XMLLink.

Parameters:

href - href

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearHref

public void clearHref()

Remove the href attribute from this XMLLink.

getHref

public String getHref()

Get the href attribute from this XMLLink. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

href on this XMLLink

hasHref

public boolean hasHref(String href)

Determine if the href attribute on this XMLLink has the given value.

Parameters:

href - Attribute value to compare

Returns:

true if they match; false otherwise.

isEquivalent

public boolean isEquivalent(IXMLLink XMLLinkToCheck)

Determine if another XMLLink is equivalent to this one, ignoring ID's.

Parameters:

XMLLinkToCheck - XMLLink to compare to this one.

Returns:

true if all the child elements of this XMLLink are equivalent, false otherwise.