| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.ivoa.registry.search.SOAPSearchClient
public class SOAPSearchClient
A client for the IVOA Registry Search Interface
| Nested Class Summary | |
|---|---|
|  class | SOAPSearchClient.SearchQueryan updatable search query | 
| Field Summary | |
|---|---|
| protected  ServiceCaller | caller | 
| protected  SOAPConnection | conn | 
| protected  java.net.URL | endpoint | 
| static java.lang.String | GETIDENTITY_ACTION | 
| static java.lang.String | GETRESOURCE_ACTION | 
| static java.lang.String | KEYWORDSEARCH_ACTION | 
| static java.lang.String | SEARCH_ACTION | 
| protected  MessageFactory | soapfactory | 
| static java.lang.String | WSDL_NS | 
| static java.lang.String | WSDL_PREFIX | 
| static java.lang.String | XQUERYSEARCH_ACTION | 
| Constructor Summary | |
|---|---|
| protected  | SOAPSearchClient() | 
|   | SOAPSearchClient(java.net.URL endpointURL)Create a client configured to connect to a given registry | 
| Method Summary | |
|---|---|
| protected  org.w3c.dom.Element | call(SOAPMessage msg,
     java.lang.String actionURI)submit the soap message | 
|  SOAPSearchClient.SearchQuery | createSearchQuery()return a SearchQuery object that can be used to attach an ADQL query to. | 
|  org.w3c.dom.Element | getIdentity()return the Registry description | 
|  org.w3c.dom.Element | getResource(java.lang.String ivoid)return the Resource description for a given identifier | 
|  org.w3c.dom.Element | keywordSearch(java.lang.String keywords,
              boolean orThem,
              int from,
              int max,
              boolean identifiersOnly)submit a keyword search | 
| protected  Name | makeRSName(SOAPMessage msg,
           java.lang.String elname) | 
|  SOAPMessage | makeSOAPMessage()create an empty SOAP message. | 
|  org.w3c.dom.Element | search(org.w3c.dom.Element adqlWhere,
       int from,
       int max,
       boolean identifiersOnly)submit a constraint-based search | 
|  org.w3c.dom.Element | search(SOAPSearchClient.SearchQuery query)submit a constraint-based search as a SearchQuery object. | 
|  void | setCaller(ServiceCaller c)set the Caller implementation to use. | 
|  org.w3c.dom.Element | xquerySearch(java.lang.String xquery)return the result of an XQuery search | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
protected java.net.URL endpoint
protected MessageFactory soapfactory
protected SOAPConnection conn
protected ServiceCaller caller
public static final java.lang.String GETIDENTITY_ACTION
public static final java.lang.String GETRESOURCE_ACTION
public static final java.lang.String SEARCH_ACTION
public static final java.lang.String KEYWORDSEARCH_ACTION
public static final java.lang.String XQUERYSEARCH_ACTION
public static final java.lang.String WSDL_NS
public static final java.lang.String WSDL_PREFIX
| Constructor Detail | 
|---|
protected SOAPSearchClient()
public SOAPSearchClient(java.net.URL endpointURL)
| Method Detail | 
|---|
public void setCaller(ServiceCaller c)
c - the caller object
public org.w3c.dom.Element keywordSearch(java.lang.String keywords,
                                         boolean orThem,
                                         int from,
                                         int max,
                                         boolean identifiersOnly)
                                  throws RegistryServiceException,
                                         SOAPException
keywords - space-delimited words to search onorThem - if true, return results that contain any of the 
                      keywordsfrom - the position of the first match to returnmax - the maximum number of matches to return.identifiersOnly - if true, return only identifiers; otherwise,
                   return the entire VOResource record for each match.
RegistryServiceException - if the service encounters an error 
                           (i.e. on the server side).
SOAPException - if an error is encountered while creating or
                           submitting the SOAP request or while processing
                           the SOAP response.
public org.w3c.dom.Element search(org.w3c.dom.Element adqlWhere,
                                  int from,
                                  int max,
                                  boolean identifiersOnly)
                           throws RegistryServiceException,
                                  SOAPException,
                                  org.w3c.dom.DOMException
adqlWhere - the search constraints in the form of a ADQL Where 
                      clause.  The element's name should be "Where", and
                      its contents should comply with the ADQL schema's
                      "WhereType".from - the position of the first match to returnmax - the maximum number of matches to return.identifiersOnly - if true, return only identifiers; otherwise,
                   return the entire VOResource record for each match.
org.w3c.dom.DOMException - if the adqlWhere Element object does not allow
                           itself to be imported or otherwise its 
                           implementation is defective.
RegistryServiceException - if the service encounters an error 
                           (i.e. on the server side).
SOAPException - if an error is encountered while creating or
                           submitting the SOAP request or while processing
                           the SOAP response.
public SOAPSearchClient.SearchQuery createSearchQuery()
                                               throws SOAPException
SOAPException - if an error is encountered while creating 
                           the SOAP request.
public org.w3c.dom.Element search(SOAPSearchClient.SearchQuery query)
                           throws RegistryServiceException,
                                  SOAPException
query - the search constraints as a SearchQuery object.
RegistryServiceException - if the service encounters an error 
                           (i.e. on the server side).
SOAPException - if an error is encountered while creating or
                           submitting the SOAP request or while processing
                           the SOAP response.
public org.w3c.dom.Element getIdentity()
                                throws RegistryServiceException,
                                       SOAPException
query - the search constraints as a SearchQuery object.
RegistryServiceException - if the service encounters an error 
                           (i.e. on the server side).
SOAPException - if an error is encountered while creating or
                           submitting the SOAP request or while processing
                           the SOAP response.
public org.w3c.dom.Element getResource(java.lang.String ivoid)
                                throws RegistryServiceException,
                                       IDNotFoundException,
                                       SOAPException
ivoid - the IVOA Identifier to resolvequery - the search constraints as a SearchQuery object.
IDNotFoundException - if the service cannot match the given
                           ID to a description
RegistryServiceException - if the service encounters an error 
                           (i.e. on the server side).
SOAPException - if an error is encountered while creating or
                           submitting the SOAP request or while processing
                           the SOAP response.
protected Name makeRSName(SOAPMessage msg,
                          java.lang.String elname)
                   throws SOAPException
SOAPException
public org.w3c.dom.Element xquerySearch(java.lang.String xquery)
                                 throws RegistryServiceException,
                                        UnsupportedOperationException,
                                        SOAPException
UnsupportedOperationException - if the service does not support
                          an XQuery-based search
RegistryServiceException - if the service encounters an error 
                           (i.e. on the server side).
SOAPException - if an error is encountered while creating or
                           submitting the SOAP request or while processing
                           the SOAP response.
public SOAPMessage makeSOAPMessage()
                            throws SOAPException
SOAPException - if an error is encountered while creating 
                           the SOAP request.
protected org.w3c.dom.Element call(SOAPMessage msg,
                                   java.lang.String actionURI)
                            throws RegistryServiceException,
                                   SOAPException
RegistryServiceException - if the service encounters an error 
                           (i.e. on the server side).
SOAPException - if an error is encountered while submitting 
                           the SOAP request or while processing
                           the SOAP response.| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||