|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.xml.sax.helpers.DefaultHandler
edu.ucsb.nceas.morpho.query.Query
A Class that represents a structured query, and can be constructed from an XML serialization conforming to @see pathquery.dtd. The printSQL() method can be used to print a SQL serialization of the query.
Constructor Summary | |
Query(Morpho morpho)
construct an instance of the Query class, manually setting the Query constraints rather that readin from an XML stream |
|
Query(java.io.Reader queryspec,
Morpho morpho)
construct an instance of the Query class from an XML Stream |
|
Query(java.lang.String queryspec,
Morpho morpho)
construct an instance of the Query class from an XML String |
Method Summary | |
void |
characters(char[] ch,
int start,
int length)
callback method used by the SAX Parser when the text sequences of an xml stream are detected. |
boolean |
containsExtendedSQL()
Returns true if the parsed query contains and extended xml query (i.e. |
void |
displaySearchResult(MorphoFrame resultWindow,
ResultPanel resultDisplayPanel,
boolean sort,
int sortIndex,
java.lang.String sortOder,
boolean showSearchNumber,
StateChangeEvent stateEvent)
This method will run the query and display the query results streamly in a given panel |
void |
endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
callback method used by the SAX Parser when the end tag of an element is detected. |
ResultSet |
execute()
Run the query against the local data store and metacat, depending on how the searchMetacat and searchLocal flags are set. |
java.util.Vector |
getFilterDocList()
Accessor method to return a vector of the filter doc types as defined in the <filterdoctype> tag in the pathquery dtd. |
java.lang.String |
getIdentifier()
Accessor method to return the identifier of this Query |
Morpho |
getMorpho()
get the morpho from query |
java.util.Vector |
getOwnerList()
Accessor method to return a vector of the owner fields as defined in the <owner> tag in the pathquery dtd. |
QueryGroup |
getQueryGroup()
get the QueryGroup used to express query constraints |
java.lang.String |
getQueryTitle()
Accessor method to return the title of this Query |
java.util.Vector |
getReturnDocList()
Accessor method to return a vector of the return document types as defined in the <returndoctype> tag in the pathquery dtd. |
java.util.Vector |
getReturnFieldList()
Accessor method to return a vector of the extended return fields as defined in the <returnfield> tag in the pathquery dtd. |
boolean |
getSearchLocal()
determine if we should search locally |
boolean |
getSearchMetacat()
determine if we should search metacat |
java.util.Vector |
getSiteList()
Accessor method to return a vector of the site fields as defined in the <site> tag in the pathquery dtd. |
static void |
main(java.lang.String[] args)
Main routine for testing |
java.lang.String |
printExtendedSQL(java.lang.String doclist)
This method prints sql based upon the <returnfield> tag in the pathquery document. |
static java.lang.String |
printGetDocByDoctypeSQL(java.lang.String docid)
|
static java.lang.String |
printPackageSQL()
Prints sql that returns all relations in the database. |
static java.lang.String |
printPackageSQL(java.lang.String docid)
Prints sql that returns all relations in the database that were input under a specific docid |
static java.lang.String |
printPackageSQL(java.lang.String subDocidURL,
java.lang.String objDocidURL)
Returns all of the relations that has a certain docid in the subject or the object. |
static java.lang.String |
printRelationSQL(java.lang.String docid)
|
java.lang.String |
printSQL(boolean useXMLIndex)
create a SQL serialization of the query that this instance represents |
void |
save()
Save an XML serialized version of the query in the profile directory |
void |
setFilterDocList(java.util.Vector filterDocList)
method to set the list of filter docs of this query |
void |
setIdentifier(java.lang.String id)
method to set the identifier of this query |
void |
setOwnerList(java.util.Vector ownerList)
method to set the list of owners used to constrain this query |
void |
setQueryGroup(QueryGroup qg)
set the QueryGroup used to express query constraints |
void |
setQueryTitle(java.lang.String title)
method to set the title of this query |
void |
setReturnDocList(java.util.Vector returnDocList)
method to set the list of return docs of this query |
void |
setReturnFieldList(java.util.Vector returnFieldList)
method to set the list of fields to be returned by this query |
void |
setSearchLocal(boolean searchLocal)
method to set searchLocal |
void |
setSearchMetacat(boolean searchMetacat)
method to set searchMetacat |
void |
setSiteList(java.util.Vector siteList)
method to set the list of sites used to constrain this query |
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes atts)
callback method used by the SAX Parser when the start tag of an element is detected. |
java.lang.String |
toString()
create a String description of the query that this instance represents. |
java.lang.String |
toXml()
create a XML serialization of the query that this instance represents |
Methods inherited from class org.xml.sax.helpers.DefaultHandler |
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Query(java.io.Reader queryspec, Morpho morpho)
queryspec
- the XML representation of the query (should conform
to pathquery.dtd) as a Readermorpho
- the Morpho application in which this Query is runpublic Query(java.lang.String queryspec, Morpho morpho)
queryspec
- the XML representation of the query (should conform
to pathquery.dtd) as a Stringmorpho
- the Morpho application which this Query is runpublic Query(Morpho morpho)
morpho
- the Morpho application in which this Query is runMethod Detail |
public boolean containsExtendedSQL()
public java.lang.String getIdentifier()
public void setIdentifier(java.lang.String id)
public java.lang.String getQueryTitle()
public void setQueryTitle(java.lang.String title)
public java.util.Vector getReturnDocList()
public void setReturnDocList(java.util.Vector returnDocList)
public java.util.Vector getFilterDocList()
public void setFilterDocList(java.util.Vector filterDocList)
public java.util.Vector getReturnFieldList()
public void setReturnFieldList(java.util.Vector returnFieldList)
public java.util.Vector getOwnerList()
public void setOwnerList(java.util.Vector ownerList)
public java.util.Vector getSiteList()
public void setSiteList(java.util.Vector siteList)
public boolean getSearchMetacat()
public void setSearchMetacat(boolean searchMetacat)
public boolean getSearchLocal()
public void setSearchLocal(boolean searchLocal)
public QueryGroup getQueryGroup()
public void setQueryGroup(QueryGroup qg)
public Morpho getMorpho()
public void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) throws org.xml.sax.SAXException
org.xml.sax.SAXException
public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) throws org.xml.sax.SAXException
org.xml.sax.SAXException
public void characters(char[] ch, int start, int length)
public java.lang.String printSQL(boolean useXMLIndex)
public java.lang.String toXml()
public java.lang.String printExtendedSQL(java.lang.String doclist)
doclist
- the list of document ids to search bypublic static java.lang.String printRelationSQL(java.lang.String docid)
public static java.lang.String printPackageSQL()
public static java.lang.String printPackageSQL(java.lang.String docid)
docid
- the docid to search for.public static java.lang.String printPackageSQL(java.lang.String subDocidURL, java.lang.String objDocidURL)
public static java.lang.String printGetDocByDoctypeSQL(java.lang.String docid)
public java.lang.String toString()
public ResultSet execute()
public void displaySearchResult(MorphoFrame resultWindow, ResultPanel resultDisplayPanel, boolean sort, int sortIndex, java.lang.String sortOder, boolean showSearchNumber, StateChangeEvent stateEvent)
resultDisplayPanel
- the result panelsort
- table need sort or notsortIndex
- column index to sortstateEvent
- event of state changepublic void save() throws java.io.IOException
java.io.IOException
public static void main(java.lang.String[] args)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |