Package com.attivio.sdk.search

Class QueryFrame

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<QueryFrame>
    public class QueryFrame
extends java.lang.Object
implements java.lang.Comparable<QueryFrame>, java.lang.Cloneable, java.io.Serializable
    EXPERIMENTAL: This API will be changed/renamed in a future release.
    See Also:
    Serialized Form

    • Constructor Detail

      • QueryFrame

        public QueryFrame()

      • QueryFrame

        public QueryFrame​(java.lang.String name)

    • Method Detail

      • getName

        public java.lang.String getName()

      • setName

        public void setName​(java.lang.String value)

      • getDescription

        public java.lang.String getDescription()
        Optional description/comment for query frame.

      • setDescription

        public void setDescription​(java.lang.String value)

      • getParents

        public java.util.List<java.lang.String> getParents()

      • setParents

        public void setParents​(java.util.List<java.lang.String> value)

      • setParents

        public void setParents​(java.lang.String... value)

      • getLocale

        public java.util.Locale getLocale()

      • setLocale

        public void setLocale​(java.util.Locale value)

      • getLastModified

        public java.util.Date getLastModified()

      • setLastModified

        public void setLastModified​(java.util.Date value)

      • getStartTime

        public java.util.Date getStartTime()

      • setStartTime

        public void setStartTime​(java.util.Date value)

      • getEndTime

        public java.util.Date getEndTime()

      • setEndTime

        public void setEndTime​(java.util.Date value)

      • isCompiled

        public boolean isCompiled()

      • setCompiled

        public void setCompiled​(boolean value)

      • isPublished

        public boolean isPublished()

      • setPublished

        public void setPublished​(boolean value)

      • getParameters

        public java.util.Map<java.lang.String,​java.lang.String[]> getParameters()

      • setParameters

        public void setParameters​(java.util.Map<java.lang.String,​java.lang.String[]> value)

      • setParameter

        public void setParameter​(java.lang.String name,
                         java.lang.String... value)

      • getInput

        public Query getInput()
        Get the input query.

        This query is used to match this query frame against a user query. If not specified, this query frame will match all user queries.

      • setInput

        public void setInput​(Query value)
        Set the input query.

        This query is used to match this query frame against a user query. If not specified, this query frame will match all user queries.

      • getQuery

        public Query getQuery()
        Get the output query.

      • setQuery

        public void setQuery​(Query value)
        Set the output query.

      • getEntities

        public java.util.Map<java.lang.String,​PhraseQuery> getEntities()
        Get additional entities to extract for query frame.

        These additional entities can be used as substitutions in the output query.

      • setEntities

        public void setEntities​(java.util.Map<java.lang.String,​PhraseQuery> value)
        Set additional entities to extract for query frame.

        These additional entities can be used as substitutions in the output query.

      • addEntity

        public void addEntity​(java.lang.String name,
                      PhraseQuery term)
        Add an additional entity to extract for query frame.

        These additional entities can be used as substitutions in the output query.

      • getFacets

        public java.util.List<FacetRequest> getFacets()

      • setFacets

        public void setFacets​(FacetRequest... value)

      • setFacets

        public void setFacets​(java.util.List<FacetRequest> value)

      • forEachFacet

        public void forEachFacet​(java.util.function.Consumer<FacetRequest> consumer)

      • getFields

        public java.util.List<FieldRequest> getFields()

      • setFields

        public void setFields​(FieldRequest... value)

      • setFields

        public void setFields​(java.util.List<FieldRequest> value)

      • forEachField

        public void forEachField​(java.util.function.Consumer<FieldRequest> consumer)

      • getFilters

        public java.util.List<Query> getFilters()

      • setFilters

        public void setFilters​(Query... value)

      • setFilters

        public void setFilters​(java.util.List<Query> value)

      • addFilter

        public void addFilter​(Query value)

      • getFacetFilters

        public java.util.List<FacetFilter> getFacetFilters()

      • setFacetFilters

        public void setFacetFilters​(FacetFilter... value)

      • setFacetFilters

        public void setFacetFilters​(java.util.List<FacetFilter> value)

      • addFacetFilter

        public void addFacetFilter​(FacetFilter value)

      • getSort

        public java.util.List<Sort> getSort()

      • setSort

        public void setSort​(Sort... value)

      • setSort

        public void setSort​(java.util.List<Sort> value)

      • addSort

        public void addSort​(Sort value)

      • getTopDocuments

        public java.util.List<java.lang.String> getTopDocuments()

      • setTopDocuments

        public void setTopDocuments​(java.lang.String... value)

      • setTopDocuments

        public void setTopDocuments​(java.util.List<java.lang.String> value)

      • addTopDocument

        public void addTopDocument​(java.lang.String value)

      • getRelevancyModels

        public java.util.List<java.lang.String> getRelevancyModels()

      • setRelevancyModels

        public void setRelevancyModels​(java.lang.String... value)

      • setRelevancyModels

        public void setRelevancyModels​(java.util.List<java.lang.String> value)

      • addRelevancyModels

        public void addRelevancyModels​(java.lang.String... value)

      • addRelevancyModels

        public void addRelevancyModels​(java.util.List<java.lang.String> value)

      • getFeedback

        public java.util.List<QueryFeedback> getFeedback()

      • setFeedback

        public void setFeedback​(QueryFeedback... value)

      • setFeedback

        public void setFeedback​(java.util.List<QueryFeedback> value)

      • addFeedback

        public void addFeedback​(java.util.List<QueryFeedback> value)

      • isActive

        public boolean isActive​(java.util.Date time)
        Returns true if this query frame is active at time.

      • compareTo

        public int compareTo​(QueryFrame other)
        Specified by:
        compareTo in interface java.lang.Comparable<QueryFrame>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • clone

        public QueryFrame clone()
        Overrides:
        clone in class java.lang.Object