|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OpenSearchContentHandler
JAXP content handler extension that defines semantic callbacks for sitemap
specific events. For each event in the sitemap namespace these semantic
events should be called instead of the untyped SAX events. For all events
outside of the ATOM namespace the methods on
ContentHandler
should be called.
Method Summary | |
---|---|
void |
endAdultContent()
|
void |
endAttribution()
|
void |
endContact()
|
void |
endDescription()
|
void |
endDeveloper()
|
void |
endImage()
|
void |
endInputEncoding()
|
void |
endItemsPerPage()
|
void |
endLanguage()
|
void |
endLongName()
|
void |
endOpenSearchDescription()
|
void |
endOutputEncoding()
|
void |
endQuery()
|
void |
endShortName()
|
void |
endStartIndex()
|
void |
endSyndicationRight()
|
void |
endTags()
|
void |
endTotalResults()
|
void |
endUrl()
|
void |
startAdultContent(org.xml.sax.Attributes attrs)
Contains a boolean value that should be set to true if the search results may contain material intended only for adults. |
void |
startAttribution(org.xml.sax.Attributes attrs)
ontains a list of all sources or entities that should be credited for the content contained in the search feed. |
void |
startContact(org.xml.sax.Attributes attrs)
Contains an email address at which the maintainer of the description document can be reached. |
void |
startDescription(org.xml.sax.Attributes attrs)
Contains a human-readable text description of the search engine. |
void |
startDeveloper(org.xml.sax.Attributes attrs)
Contains the human-readable name or identifier of the creator or maintainer of the description document. |
void |
startImage(java.lang.String oWidth,
java.lang.String oHeight,
java.lang.String oType,
org.xml.sax.Attributes attrs)
Contains a URL that identifies the location of an image that can be used in association with this search content. |
void |
startInputEncoding(org.xml.sax.Attributes attrs)
Contains a string that indicates that the search engine supports search requests encoded with the specified character encoding. |
void |
startItemsPerPage(org.xml.sax.Attributes attrs)
The number of search results returned per page. |
void |
startLanguage(org.xml.sax.Attributes attrs)
Contains a string that indicates that the search engine supports search results in the specified language. |
void |
startLongName(org.xml.sax.Attributes attrs)
Contains an extended human-readable title that identifies this search engine. |
void |
startOpenSearchDescription(org.xml.sax.Attributes attrs)
The root node of the OpenSearch description document. |
void |
startOutputEncoding(org.xml.sax.Attributes attrs)
Contains a string that indicates that the search engine supports search responses encoded with the specified character encoding. |
void |
startQuery(java.lang.String rRole,
java.lang.String oTitle,
java.lang.String oTotalResults,
java.lang.String oSearchTerms,
java.lang.String oCount,
java.lang.String oStartIndex,
java.lang.String oStartPage,
java.lang.String oLanguage,
java.lang.String oInputEncoding,
java.lang.String oOutputEncoding,
org.xml.sax.Attributes attrs)
Describes a specific search request that can be made by the search client. |
void |
startShortName(org.xml.sax.Attributes attrs)
Contains a brief human-readable title that identifies this search engine. |
void |
startStartIndex(org.xml.sax.Attributes attrs)
The index of the first search result in the current set of search results. |
void |
startSyndicationRight(org.xml.sax.Attributes attrs)
Contains a value that indicates the degree to which the search results provided by this search engine can be queried, displayed, and redistributed. |
void |
startTags(org.xml.sax.Attributes attrs)
Contains a set of words that are used as keywords to identify and categorize this search content. |
void |
startTotalResults(org.xml.sax.Attributes attrs)
The number of search results available for the current search. |
void |
startUrl(java.lang.String rTemplate,
java.lang.String rType,
java.lang.String oIndexOffset,
java.lang.String oPageOffset,
org.xml.sax.Attributes attrs)
Describes an interface by which a search client can make search requests of the search engine. |
Methods inherited from interface org.xml.sax.ContentHandler |
---|
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping |
Method Detail |
---|
void endAdultContent() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endAttribution() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endContact() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endDescription() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endDeveloper() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endImage() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endInputEncoding() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endItemsPerPage() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endLanguage() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endLongName() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endOpenSearchDescription() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endOutputEncoding() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endQuery() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endShortName() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endStartIndex() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endSyndicationRight() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endTags() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endTotalResults() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void endUrl() throws org.xml.sax.SAXException
org.xml.sax.SAXException
void startAdultContent(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains a boolean value that should be set to true if the search results may contain material intended only for adults.
As there are no universally applicable guidelines as to what constitutes "adult" content, the search engine should make a good faith effort to indicate when there is a possibility that search results may contain material inappropriate for all audiences.
attrs
-
org.xml.sax.SAXException
void startAttribution(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
attrs
-
org.xml.sax.SAXException
void startContact(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains an email address at which the maintainer of the description document can be reached.
attrs
-
org.xml.sax.SAXException
void startDescription(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains a human-readable text description of the search engine.
attrs
-
org.xml.sax.SAXException
void startDeveloper(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains the human-readable name or identifier of the creator or maintainer of the description document.
The developer is the person or entity that created the description document, and may or may not be the owner, author, or copyright holder of the source of the content itself.
attrs
-
org.xml.sax.SAXException
void startInputEncoding(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains a string that indicates that the search engine supports search requests encoded with the specified character encoding.
An OpenSearch description document should include one "InputEncoding" element for each character encoding that can be used to encode search requests. The "inputEncoding" template parameter in the OpenSearch URL template can be used to require the search client to identify which encoding is being used to encode the current search request.
attrs
-
org.xml.sax.SAXException
void startItemsPerPage(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
The number of search results returned per page.
If the itemsPerPage element does not appear on the page then the search client should use the number of items of the current page as the default page size.
attrs
-
org.xml.sax.SAXException
void startLanguage(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains a string that indicates that the search engine supports search results in the specified language.
An OpenSearch description document should include one "Language" element for each language that the search engine supports. If the search engine also supports queries for any arbitrary language then the OpenSearch description document should include a Language element with a value of "*". The "language" template parameter in the OpenSearch URL template can be used to allow the search client to choose among the available languages.
attrs
-
org.xml.sax.SAXException
void startLongName(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains an extended human-readable title that identifies this search engine.
Search clients should use the value of the ShortName element if this element is not available.
attrs
-
org.xml.sax.SAXException
void startOpenSearchDescription(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
attrs
-
org.xml.sax.SAXException
void startOutputEncoding(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains a string that indicates that the search engine supports search responses encoded with the specified character encoding.
An OpenSearch description document should include one "OutputEncoding" element for each character encoding that can be used to encode search responses. The "outputEncoding" template parameter in the OpenSearch URL template can be used to allow the search client to choose a character encoding in the search response.
attrs
-
org.xml.sax.SAXException
void startQuery(java.lang.String rRole, java.lang.String oTitle, java.lang.String oTotalResults, java.lang.String oSearchTerms, java.lang.String oCount, java.lang.String oStartIndex, java.lang.String oStartPage, java.lang.String oLanguage, java.lang.String oInputEncoding, java.lang.String oOutputEncoding, org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Describes a specific search request that can be made by the search client.
role
- Contains a string identifying how the search
client should interpret the search request defined by this Query element.
title
- Contains a human-readable plain text string
describing the search request.
totalResults
- Contains the expected number of
results to be found if the search request were made.
searchTerms
- Contains the value representing the
"searchTerms" as an OpenSearch 1.1 parameter.
count
- Contains the value representing the "count"
as a OpenSearch 1.1
parameter.
startIndex
- Contains the value representing the
"startIndex" as an OpenSearch 1.1 parameter.
startPage
- Contains the value representing the
"startPage" as an OpenSearch 1.1 parameter.
language
- Contains the value representing the
"language" as an OpenSearch
1.1 parameter.
inputEncoding
- Contains the value representing the
"inputEncoding" as an OpenSearch 1.1 parameter.
outputEncoding
- Contains the value representing the
"outputEncoding" as an OpenSearch 1.1 parameter.
org.xml.sax.SAXException
void startShortName(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains a brief human-readable title that identifies this search engine.
attrs
-
org.xml.sax.SAXException
void startStartIndex(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
The index of the first search result in the current set of search results.
If the startIndex element does not appear on the page then the search client should consider the current page to be the first page of search results.
attrs
-
org.xml.sax.SAXException
void startSyndicationRight(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains a value that indicates the degree to which the search results provided by this search engine can be queried, displayed, and redistributed.
"open"
�
"limited"
�
"private"
�
"closed"
-
attrs
-
org.xml.sax.SAXException
void startTags(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains a set of words that are used as keywords to identify and categorize this search content. Tags must be a single word and are delimited by the space character (' ').
attrs
-
org.xml.sax.SAXException
void startTotalResults(org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
The number of search results available for the current search.
If the totalResults element does not appear on the page then the search client should consider the current page to be the last page of search results.
attrs
-
org.xml.sax.SAXException
void startUrl(java.lang.String rTemplate, java.lang.String rType, java.lang.String oIndexOffset, java.lang.String oPageOffset, org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Describes an interface by which a search client can make search requests of the search engine.
OpenSearch provides support for both index-based and page-based search engines. By default, both the first search result and the first page of search results are numbered "1". Search engines can use the "indexOffset" and "pageOffset" attributes to inform search clients of different starting values.
template
- Contains the search URL template to be
processed according to the OpenSearch URL template syntax.
type
- Contains the MIME type of the search result
format.
indexOffset
- Contains the index number of the first
search result.
pageOffset
- Contains the page number of the first
set of search results.
Example of a Url element describing the interface used to retrieve
search results over RSS:
<Url type="application/rss+xml" template="http://example.com/?q={searchTerms}&pw={startPage?}" />
Example of a Url element describing the interface used to retrieve 0-based search results over XHTML:
<Url type="application/xhtml+xml" indexOffset="0" template="http://example.com/search?q={searchTerms}&start={startIndex?}" />
attrs
-
org.xml.sax.SAXException
void startImage(java.lang.String oWidth, java.lang.String oHeight, java.lang.String oType, org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
Contains a URL that identifies the location of an image that can be used in association with this search content.
Image sizes are offered as a hint to the search client. The search client will chose the most appropriate image for the available space and should give preference to those listed first in the OpenSearch description document. Square aspect ratios are recommended. When possible, search engines should offer a 16x16 image of type "image/x-icon" or "image/vnd.microsoft.icon" (the Microsoft ICON format) and a 64x64 image of type "image/jpeg" or "image/png".
height
� Contains the height, in pixels, of this
image.
width
� Contains the width, in pixels, of this image.
type
� Contains the the MIME type of this image.
oWidth
- oHeight
- oType
- attrs
-
org.xml.sax.SAXException
com.ibm.wps.resolver.model.xml.helper.MIME_Types.ICON
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |