com.google.gdata.data

Class OpenSearchDescriptionDocument

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.OpenSearchDescriptionDocument

All Implemented Interfaces:

Extension

public class OpenSearchDescriptionDocument
extends ExtensionPoint

OpenSearch description document. See http://opensearch.a9.com/ for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OpenSearchDescriptionDocument.Handler XmlParser ElementHandler for openSearchDesc:OpenSearchDescription
static class	OpenSearchDescriptionDocument.SyndicationRight The SyndicationRight class defines constant values for syndication rights types.

Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	adultContent A boolean flag that must be set if the content provided is not suitable for minors.
protected String	attribution A list of all content sources or platforms that should be credited.
protected String	contact An email address at which the developer can be reached.
protected String	description A human readable text description of the search content provider.
protected String	developer The developer or maintainer of the OpenSearch feed.
protected String	format The XML schema used by the search engine specified by url.
protected String	image A URL that identifies the location of a 64x64-pixel image that can be used in association with this search engine.
protected String	longName The name by which this search content provider is referred to in hypertext links, etc.
protected String	sampleSearch A search string that should be used when example searches are done against this OpenSearch engine.
protected String	shortName A brief name that will appear in UI elements that reference this search content provider.
protected int	syndicationRight The degree to which the search results provided by this search engine can be distributed.
protected String	tags A space-delimited set of words that are used as keywords to identify and categorize this search content.
protected String	url The HTTP GET URL at which the search content can be found.

Fields inherited from class com.google.gdata.data.ExtensionPoint

xmlBlob

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
OpenSearchDescriptionDocument()
OpenSearchDescriptionDocument(OpenSearchDescriptionDocument doc)

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(XmlWriter w) Generates XML.
boolean	getAdultContent()
String	getAttribution()
String	getContact()
String	getDescription()
String	getDeveloper()
String	getFormat()
String	getImage()
String	getLongName()
String	getSampleSearch()
String	getShortName()
int	getSyndicationRight()
String	getTags()
String	getUrl()
void	parse(ExtensionProfile extProfile, Reader reader) Parses XML.
void	setAdultContent(boolean v)
void	setAttribution(String v)
void	setContact(String v)
void	setDescription(String v)
void	setDeveloper(String v)
void	setFormat(String v)
void	setImage(String v)
void	setLongName(String v)
void	setSampleSearch(String v)
void	setShortName(String v)
void	setSyndicationRight(int v)
void	setTags(String v)
void	setUrl(String v)
void	validateConfiguration() Validates that the OpenSearchDescriptionDocument has all required properties.

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getHandler, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild, visitChildren

Methods inherited from class com.google.gdata.data.AbstractExtension

consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate

Methods inherited from class java.lang.Object

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

Field Detail

url

protected String url

The HTTP GET URL at which the search content can be found.

format

protected String format

The XML schema used by the search engine specified by url.

shortName

protected String shortName

A brief name that will appear in UI elements that reference this search content provider.

longName

protected String longName

The name by which this search content provider is referred to in hypertext links, etc.

description

protected String description

A human readable text description of the search content provider.

tags

protected String tags

A space-delimited set of words that are used as keywords to identify and categorize this search content.

image

protected String image

A URL that identifies the location of a 64x64-pixel image that can be used in association with this search engine.

sampleSearch

protected String sampleSearch

A search string that should be used when example searches are done against this OpenSearch engine.

developer

protected String developer

The developer or maintainer of the OpenSearch feed.

contact

protected String contact

An email address at which the developer can be reached.

attribution

protected String attribution

A list of all content sources or platforms that should be credited.

syndicationRight

protected int syndicationRight

The degree to which the search results provided by this search engine can be distributed.

adultContent

protected boolean adultContent

A boolean flag that must be set if the content provided is not suitable for minors.

Constructor Detail

OpenSearchDescriptionDocument

public OpenSearchDescriptionDocument()

OpenSearchDescriptionDocument

public OpenSearchDescriptionDocument(OpenSearchDescriptionDocument doc)

Method Detail

getUrl

public final String getUrl()

setUrl

public void setUrl(String v)

getFormat

public final String getFormat()

setFormat

public void setFormat(String v)

getShortName

public final String getShortName()

setShortName

public void setShortName(String v)

getLongName

public final String getLongName()

setLongName

public void setLongName(String v)

getDescription

public final String getDescription()

setDescription

public void setDescription(String v)

getTags

public final String getTags()

setTags

public void setTags(String v)

getImage

public final String getImage()

setImage

public void setImage(String v)

getSampleSearch

public final String getSampleSearch()

setSampleSearch

public void setSampleSearch(String v)

getDeveloper

public final String getDeveloper()

setDeveloper

public void setDeveloper(String v)

getContact

public final String getContact()

setContact

public void setContact(String v)

getAttribution

public final String getAttribution()

setAttribution

public void setAttribution(String v)

getSyndicationRight

public final int getSyndicationRight()

setSyndicationRight

public void setSyndicationRight(int v)

getAdultContent

public final boolean getAdultContent()

setAdultContent

public void setAdultContent(boolean v)

generate

public void generate(XmlWriter w)
              throws IOException

Generates XML.

Parameters:

w - output writer

Throws:

IOException

validateConfiguration

public void validateConfiguration()
                           throws ServiceConfigurationException

Validates that the OpenSearchDescriptionDocument has all required properties. The one exception is the url property, which is dynamically generated based upon the feed that is queried.

Throws:

ServiceConfigurationException

parse

public void parse(ExtensionProfile extProfile,
         Reader reader)
           throws IOException,
                  ParseException

Parses XML.

Parameters:

extProfile - extension profile

reader - XML input stream

Throws:

IOException

ParseException