arcade.mod.model
Interface IResourceNode

All Known Implementing Classes:

XMLNode

public interface IResourceNode

Contains all the available information on a Resource in the model. This may include children, attributes, and a description. From these attributes are mod-able.

Method Summary

java.lang.String	getAttribute(java.lang.String attributeName) Get the String value of an Attribute of the ResourceNode given the name of the desired Attribute.
java.util.Collection<java.lang.String>	getAttributes() Returns Attributes of the ResourceNodes.
java.util.List<IResourceNode>	getChildren() Return a List of the subnodes to this ResourceNode.
java.lang.String	getDescription() Get a short description of what this ResourceNode represents.
java.lang.String	getModelPath()
org.w3c.dom.Node	getNode()
void	setAttribute(java.lang.String attributeName, java.lang.String value) Overwrites the current String value of an Attribute given the name of the desired Attribute.

Method Detail

getChildren

java.util.List<IResourceNode> getChildren()

Return a List of the subnodes to this ResourceNode. Currently all implemented Resource types do not have Children except for a Description, so this method is currently unused.

Returns:

List of children ResourceNodes

getAttributes

java.util.Collection<java.lang.String> getAttributes()

Returns Attributes of the ResourceNodes. Effectively, Attributes are keys to String values in a map and this method retrieves a list of keys.

Returns:

Collection of all attribute types for this ResourceNode

getAttribute

java.lang.String getAttribute(java.lang.String attributeName)

Get the String value of an Attribute of the ResourceNode given the name of the desired Attribute.

Parameters:

attributeName - the name of the desired Attribute

Returns:

the String value of the requested Attribute

setAttribute

void setAttribute(java.lang.String attributeName,
                  java.lang.String value)

Overwrites the current String value of an Attribute given the name of the desired Attribute.

Parameters:

attributeName - the name of the desired Attribute

value - the String to set the Attribute to

getDescription

java.lang.String getDescription()

Get a short description of what this ResourceNode represents. Generally should be a phrase to two sentences in length.

Returns:

description of this ResourceNode

getModelPath

java.lang.String getModelPath()

getNode

org.w3c.dom.Node getNode()