edu.wisc.trace.urcsdk.client.resources
Class AResourceDescription

java.lang.Object
  edu.wisc.trace.urcsdk.client.resources.AResourceDescription

public class AResourceDescription
extends java.lang.Object

AResourceDescription is the object representation of an Atomic resource as defined by the specs and described in Resource Sheet XML documents.

Version:

$Revision: 1.21 $

Author:

Andrew Martin, Trace R&D Center Created on: Sep 7, 2004

Field Summary

static java.lang.String

ANONYMOUS_DESCRIPTION

Constructor Summary

AResourceDescription(ResourceSheet parent, org.w3c.dom.Element element)
Creates a new AResourceDescription instance.

Method Summary

java.util.List<ElementRef>	getElementRefs() Returns a list of the element references in this resource description.
java.util.List<java.lang.String>	getValueRefs() Returns a list of the value references in this resource description.
boolean	hasUserPreferences(UserPreferences uprefs) Returns true if the given UserPreferences is contained in this resource description.
IResource	toResource() Returns the IResource representation of this object.
java.lang.String	toString() Returns the String representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

ANONYMOUS_DESCRIPTION

public static final java.lang.String ANONYMOUS_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

AResourceDescription

public AResourceDescription(ResourceSheet parent,
                            org.w3c.dom.Element element)
                     throws UrcException

Creates a new AResourceDescription instance.

Parameters:

parent - a ResourceSheet value

element - an Element value

Throws:

UrcException - if an error occurs

Method Detail

toString

public java.lang.String toString()

Returns the String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

a String value

toResource

public IResource toResource()

Returns the IResource representation of this object.

Returns:

an IResource object.

hasUserPreferences

public boolean hasUserPreferences(UserPreferences uprefs)

Returns true if the given UserPreferences is contained in this resource description.

Parameters:

uprefs - the UserPreferences to check

Returns:

a boolean value

getValueRefs

public java.util.List<java.lang.String> getValueRefs()

Returns a list of the value references in this resource description.

Returns:

a List of String objects.

getElementRefs

public java.util.List<ElementRef> getElementRefs()

Returns a list of the element references in this resource description.

Returns:

a List of ElementRef objects.