edu.wisc.trace.urcsdk.client.resources
Interface IResource

All Known Implementing Classes:

AbstractResource, EmptyResource, ImageResource, ListResource, TextResource

public interface IResource

IResource is the interface used for creating new resource types from scratch. All Resources must ultimately stem from this interface so they can properly interface with the rest of the SDK.

Version:

$Revision: 1.21 $

Author:

Andrew Martin, Trace R&D Center Created on: Feb 15, 2005

Field Summary

static IResource

EMPTY_RESOURCE An empty resource.

Method Summary

boolean	equals(IResource r)
ElementRef	getElementRef()
java.lang.String	getFormat() Return the DCMI format property of resource (MIME type).
java.util.List<java.lang.String>	getLangs() Returns the List of languages for this IResource
java.lang.String	getOperationRef()
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	getPropertiesMap()
java.lang.Object	getProperty(java.lang.String property)
Constants.ResourceRole	getRole()
Constants.ResourceType	getType() Returns DCMI type property of resource (e.g.
java.lang.Object	getValue() Returns the value of this Resource
java.lang.String	getValueRef()
java.lang.String	toString() String representation of this Object.

Field Detail

EMPTY_RESOURCE

static final IResource EMPTY_RESOURCE

An empty resource.

Method Detail

equals

boolean equals(IResource r)

getElementRef

ElementRef getElementRef()

Returns:

String representing the reference to the socket element for this resource.

getFormat

java.lang.String getFormat()

Return the DCMI format property of resource (MIME type).

Returns:

a String value

getLangs

java.util.List<java.lang.String> getLangs()

Returns the List of languages for this IResource

Returns:

List of languages for this Resource

getOperationRef

java.lang.String getOperationRef()

Returns:

String representing the operator reference for the socket element for this resource.

getPropertiesMap

java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getPropertiesMap()

Returns:

Map of Properties of this Resource

getProperty

java.lang.Object getProperty(java.lang.String property)

Parameters:

property - The property for which the value is needed

Returns:

The value for the requested property

getRole

Constants.ResourceRole getRole()

Returns:

ResourceRole for this Resource

getType

Constants.ResourceType getType()

Returns DCMI type property of resource (e.g. Text or Image)

Returns:

the ResourceType of this resource

getValue

java.lang.Object getValue()

Returns the value of this Resource

Returns:

an Object value

getValueRef

java.lang.String getValueRef()

Returns:

String representing the value reference for the socket element for this resource.

toString

java.lang.String toString()

String representation of this Object.

Overrides:

toString in class java.lang.Object

Returns:

a String value