|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate
public class BasicURLTemplate
Class implementing the URLTemplate interface
Constructor Summary | |
---|---|
BasicURLTemplate(java.lang.String template,
java.util.Map<java.lang.String,java.lang.String> nsPrefixes)
Creates a new BasicURLTemplate object |
Method Summary | |
---|---|
java.util.List<java.lang.String> |
getOptionalParameters()
Returns a list containing the qualified names of all optional parameters contained in the template |
java.util.List<java.lang.String> |
getRequiredParameters()
Returns a list containing the qualified names of all required parameters contained in the template |
java.lang.String |
getTemplate()
Returns the query template |
boolean |
hasParameter(java.lang.String name)
Determines if the template contains a parameter with a given qualified name |
boolean |
isParameterRequired(java.lang.String name)
Determines if a parameter with a given qualified name is a required parameter |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BasicURLTemplate(java.lang.String template, java.util.Map<java.lang.String,java.lang.String> nsPrefixes) throws java.lang.Exception
template
- The query template that will be usednsPrefixes
- The mapping from namespace URIs to namespace prefixes for all namespaces contained in a description document
java.lang.Exception
- If a parameter namespace URI is not present in the description document or in case of other errorMethod Detail |
---|
public java.util.List<java.lang.String> getRequiredParameters()
getRequiredParameters
in interface URLTemplate
URLTemplate.getRequiredParameters()
public java.util.List<java.lang.String> getOptionalParameters()
getOptionalParameters
in interface URLTemplate
URLTemplate.getOptionalParameters()
public boolean isParameterRequired(java.lang.String name) throws NonExistentParameterException
isParameterRequired
in interface URLTemplate
name
- The qualified name of the parameter
NonExistentParameterException
- If the parameter is not found among the parameters contained in the templateURLTemplate.isParameterRequired(String)
public boolean hasParameter(java.lang.String name)
hasParameter
in interface URLTemplate
name
- The qualified name of the parameter
URLTemplate.hasParameter(String)
public java.lang.String getTemplate()
getTemplate
in interface URLTemplate
URLTemplate.getTemplate()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |