org.apache.shindig.gadgets.spec

Class GadgetSpec

java.lang.Object

org.apache.shindig.gadgets.spec.GadgetSpec

public class GadgetSpec
extends Object

Represents a gadget specification root element (Module).

See Also:

gadgets spec

Field Summary

Fields

Modifier and Type	Field and Description
static Locale	DEFAULT_LOCALE
static String	DEFAULT_VIEW
static String	DOCTYPE_QUIRKSMODE
protected ExternalServices	externalServices ExternalServices
protected ModulePrefs	modulePrefs ModulePrefs
protected Map<String,UserPref>	userPrefs UserPref
protected Map<String,View>	views Content Mapping is view -> Content section.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GadgetSpec(GadgetSpec spec) Constructs a GadgetSpec for substitute calls.
	GadgetSpec(Uri url, Element doc, String original) Creates a new Module from the given xml input.
	GadgetSpec(Uri url, String xml) Use for testing.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String key)
String	getChecksum()
ExternalServices	getExternalServices()
ModulePrefs	getModulePrefs()
OpenSocialVersion	getSpecificationVersion() Returns this Gadget's specification version.
Uri	getUrl()
Map<String,UserPref>	getUserPrefs()
View	getView(String name) Retrieves a single view by name.
Map<String,View>	getViews()
GadgetSpec	removeUrlViews() Returns a copy of the spec with all type=url views removed.
void	setAttribute(String key, Object o) Sets an attribute on the gadget spec.
GadgetSpec	substitute(Substitutions substituter) Performs substitutions on the spec.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VIEW

public static final String DEFAULT_VIEW

See Also:

Constant Field Values

DEFAULT_LOCALE

public static final Locale DEFAULT_LOCALE

DOCTYPE_QUIRKSMODE

public static final String DOCTYPE_QUIRKSMODE

See Also:

Constant Field Values

modulePrefs

protected ModulePrefs modulePrefs

ModulePrefs

userPrefs

protected Map<String,UserPref> userPrefs

UserPref

views

protected Map<String,View> views

Content Mapping is view -> Content section.

externalServices

protected ExternalServices externalServices

ExternalServices

Constructor Detail

GadgetSpec

public GadgetSpec(Uri url,
          Element doc,
          String original)
           throws SpecParserException

Creates a new Module from the given xml input.

Parameters:

url - The original url of the gadget.

doc - The pre-parsed xml document.

original - Unparsed input XML. Used to generate checksums.

Throws:

SpecParserException - If xml can not be processed as a valid gadget spec.

GadgetSpec

public GadgetSpec(Uri url,
          String xml)
           throws SpecParserException

Use for testing.

Throws:

SpecParserException

GadgetSpec

protected GadgetSpec(GadgetSpec spec)

Constructs a GadgetSpec for substitute calls.

Parameters:

spec -

Method Detail

getSpecificationVersion

public OpenSocialVersion getSpecificationVersion()

Returns this Gadget's specification version. Defaults to 1.0 if attribute not set.

Returns:

Version value as String

getUrl

public Uri getUrl()

getChecksum

public String getChecksum()

getModulePrefs

public ModulePrefs getModulePrefs()

getUserPrefs

public Map<String,UserPref> getUserPrefs()

getViews

public Map<String,View> getViews()

getExternalServices

public ExternalServices getExternalServices()

getView

public View getView(String name)

Retrieves a single view by name.

Parameters:

name - The name of the view you want to see

Returns:

The view object, if it exists, or null.

getAttribute

public Object getAttribute(String key)

setAttribute

public void setAttribute(String key,
                Object o)

Sets an attribute on the gadget spec. This should only be done during a constructing phase, as a GadgetSpec should be effectively immutable after it is constructed.

Parameters:

key - The attribute name.

o - The value of the attribute.

substitute

public GadgetSpec substitute(Substitutions substituter)

Performs substitutions on the spec. See individual elements for details on what gets substituted.

Parameters:

substituter -

Returns:

The substituted spec.

removeUrlViews

public GadgetSpec removeUrlViews()

Returns a copy of the spec with all type=url views removed.

toString

public String toString()

Overrides:

toString in class Object