|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement
public class BasicURLElement
URL element class implementing the URLElement interface, which provides standard OpenSearch URL element functionality
Constructor Summary | |
---|---|
BasicURLElement(org.w3c.dom.Element url,
java.util.Map<java.lang.String,java.lang.String> nsPrefixes)
Creates a new BasicURLElement |
Method Summary | |
---|---|
int |
getIndexOffset()
Returns the value of the indexOffset OpenSearch parameter contained in this URL element. |
java.lang.String |
getMimeType()
Retrieves the MIME type associated with the results obtained after issuing a query using the template contained in this URL element |
int |
getPageOffset()
Returns the value of the pageOffset OpenSearch parameter contained in this URL element. |
QueryBuilder |
getQueryBuilder()
Constructs and returns a QueryBuilder object that can be used to construct queries based on the template contained in this query element. |
java.lang.String |
getRel()
Returns the role of the resource being described in relation to the description document |
boolean |
isRelSupported()
Answers whether the rel value of the URL element can be interpreted by this URL element type |
void |
parse()
Processes a URL element |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BasicURLElement(org.w3c.dom.Element url, java.util.Map<java.lang.String,java.lang.String> nsPrefixes)
url
- An Element instance containing the URL element to be processednsPrefixes
- The mapping from namespace URIs to namespace prefixes for all namespaces contained in a description documentMethod Detail |
---|
public void parse() throws java.lang.Exception
parse
in interface URLElement
java.lang.Exception
- If the URL element is not valid according to the OpenSearch specification or in case of other errorURLElement.parse()
public java.lang.String getMimeType() throws java.lang.Exception
getMimeType
in interface URLElement
java.lang.Exception
- If the URL element is not initialized or in case of other errorURLElement.getMimeType()
public int getIndexOffset() throws java.lang.Exception
getIndexOffset
in interface URLElement
java.lang.Exception
- If the URL element is not initialized or in case of other errorURLElement.getIndexOffset()
public int getPageOffset() throws java.lang.Exception
getPageOffset
in interface URLElement
java.lang.Exception
- If the URL element is not initialized or in case of other errorURLElement.getPageOffset()
public java.lang.String getRel() throws java.lang.Exception
getRel
in interface URLElement
java.lang.Exception
- If the URL element is not initialized or in case of other errorURLElement.getRel()
public boolean isRelSupported() throws java.lang.Exception
isRelSupported
in interface URLElement
java.lang.Exception
- If the URL element is not initialized or in case of other errorURLElement.isRelSupported()
public QueryBuilder getQueryBuilder() throws java.lang.Exception
getQueryBuilder
in interface URLElement
java.lang.Exception
- In case of other error during QueryBuilder
constructionURLElement.getQueryBuilder()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |