public interface SearchFactory
Modifier and Type | Method and Description |
---|---|
Search |
createExampleSearch() |
de.ims.icarus.ui.helper.Editor<de.ims.icarus.util.Options> |
createParameterEditor() |
SearchQuery |
createQuery()
Creates an empty query usable for setting up a search.
|
Search |
createSearch(SearchQuery query,
java.lang.Object target,
de.ims.icarus.util.Options options)
Constructs a new
Search object that can be scheduled
to run the search-constraints encoded within the
query argument. |
Search |
createSearch(java.lang.String query,
java.lang.String target,
de.ims.icarus.util.Options options) |
de.ims.icarus.util.data.ContentType |
getContentType() |
java.lang.Class<? extends QueryEditor> |
getDefaultEditorClass()
Returns the class of the
QueryEditor to be used when editing
queries for this factory. |
java.lang.String |
getQueryLabel(SearchQuery query)
Generates a context specific label for the given
SearchQuery . |
java.lang.String |
getSerializedForm() |
java.lang.String |
getSerializedTarget(Search search) |
Search createSearch(java.lang.String query, java.lang.String target, de.ims.icarus.util.Options options) throws java.lang.Exception
java.lang.Exception
java.lang.String getSerializedForm()
java.lang.String getSerializedTarget(Search search)
Search createSearch(SearchQuery query, java.lang.Object target, de.ims.icarus.util.Options options) throws de.ims.icarus.util.UnsupportedFormatException
Search
object that can be scheduled
to run the search-constraints encoded within the
query
argument. Implementations are required to support
all the parameters defined in SearchParameters
when passed
as part of the options
argument.de.ims.icarus.util.UnsupportedFormatException
- in case the query
contains
illegal SearchConstraint
instances or is of an unsupported
structure (e.g. a factory for tree-structures would reject a full
grown graph object)Search createExampleSearch() throws java.lang.Exception
java.lang.Exception
de.ims.icarus.util.data.ContentType getContentType()
SearchQuery createQuery()
de.ims.icarus.ui.helper.Editor<de.ims.icarus.util.Options> createParameterEditor()
java.lang.Class<? extends QueryEditor> getDefaultEditorClass()
QueryEditor
to be used when editing
queries for this factory. If a null
value is returned the
framework assumes the DefaultQueryEditor
implementation to be
sufficient.java.lang.String getQueryLabel(SearchQuery query)
SearchQuery
.
A return value of null
indicates that the framework should
generate a default label.