public class QueryField extends Object implements XMLSerializable
defines a set of query fields. Each field is composed
of one DocumentField which specifies properties such as name, description and type, and a set of conditions
that may apply to the field. For example, a service may provide searching on dates by combining a date field with the
conditions DATE_AFTER, DATE_BEFORE and so on. For example,
AdvancedSearchQueryTerm.Condition[] conditions = new AdvancedSearchQueryTerm.Condition[]{
AdvancedSearchQueryTerm.Condition.IN_RANGE,
AdvancedSearchQueryTerm.Condition.DATE_AFTER_OR_ON,
AdvancedSearchQueryTerm.Condition.DATE_BEFORE_OR_ON
};
DocumentField field = createDateField("creation date", "search by dates", "datecode");
return new QueryField(field, conditions);
The code above directs geneious to display a "creation date" search field in the advanced search
panel for that service, and in that field Geneious allows the user to specifies either one or two dates with the
appropriate conditions. Upon clicking on search, the field and values are used to construct a query search term, which becomes part of the search query passed to the service.XMLSerializable.OldVersionCompatible, XMLSerializable.VersionSupportType| Modifier and Type | Field and Description |
|---|---|
Condition[] |
conditions
Possible conditions on field.
|
DocumentField |
field
Field to search on.
|
ROOT_ELEMENT_NAME| Constructor and Description |
|---|
QueryField()
Empty constructor used only during XML serialisation.
|
QueryField(DocumentField field,
Condition[] conditions)
Constructor.
|
public DocumentField field
public Condition[] conditions
public QueryField(DocumentField field, Condition[] conditions)
field - the field to search onconditions - an conditions attached to the fieldpublic QueryField()
public org.jdom.Element toXML()
XMLSerializableXMLSerializable.fromXML(org.jdom.Element) can completely
restore the objects representation.
It is recommended that the returned element use XMLSerializable.ROOT_ELEMENT_NAME as its name,
in which case it must not define an attribute called "type". In this case,
fromXML, will be called with an element whose name may differ from the element
return from this function. This recommendation allows a more compact representation
of the XML can be stored.
This method generally should not be called directly. Instead, you should usually call
XMLSerializer.classToXML(String, XMLSerializable)
which calls this method internally.
PluginDocument implementations of this method may choose to throw an XMLSerializationException,
enclosed in a RuntimeException.toXML in interface XMLSerializablepublic void fromXML(org.jdom.Element element)
throws XMLSerializationException
XMLSerializableXMLSerializable.toXML().
This method generally should not be called directly. Instead, you should usually call
XMLSerializer.classFromXML(org.jdom.Element)
or XMLSerializer.classFromXML(org.jdom.Element, Class)
which calls this method internally.
It is optional to implement this method. Instead of implementing an empty constructor and implementing
this method properly, the implementation may instead
throw an UnsupportedOperationException and implement a constructor
that takes a single Element as a parameter.
This allows for cleaner code such as support for final fields in the XMLSerializable class.
The element parameter should not be modified since it may be reused. If you need a modified version of it,
take a copy with Element.clone().fromXML in interface XMLSerializableelement - representation from a previous call to XMLSerializable.toXML()XMLSerializationException - if the Element can't be converted into this type of object