Class SolrSearchQueryTemplateModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class SolrSearchQueryTemplateModel
    extends ItemModel
    Generated model class for type SolrSearchQueryTemplate first defined at extension solrfacetsearch.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _SOLRINDEXEDTYPE2SOLRSEARCHQUERYTEMPLATE
      Generated relation code constant for relation SolrIndexedType2SolrSearchQueryTemplate defining source attribute indexedType in extension solrfacetsearch.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String ENABLEHIGHLIGHTING
      Generated constant - Attribute key of SolrSearchQueryTemplate.enableHighlighting attribute defined at extension solrfacetsearch.
      static java.lang.String FTSQUERYBUILDER
      Generated constant - Attribute key of SolrSearchQueryTemplate.ftsQueryBuilder attribute defined at extension solrfacetsearch.
      static java.lang.String FTSQUERYBUILDERPARAMETERS
      Generated constant - Attribute key of SolrSearchQueryTemplate.ftsQueryBuilderParameters attribute defined at extension solrfacetsearch.
      static java.lang.String GROUP
      Generated constant - Attribute key of SolrSearchQueryTemplate.group attribute defined at extension solrfacetsearch.
      static java.lang.String GROUPFACETS
      Generated constant - Attribute key of SolrSearchQueryTemplate.groupFacets attribute defined at extension solrfacetsearch.
      static java.lang.String GROUPLIMIT
      Generated constant - Attribute key of SolrSearchQueryTemplate.groupLimit attribute defined at extension solrfacetsearch.
      static java.lang.String GROUPPROPERTY
      Generated constant - Attribute key of SolrSearchQueryTemplate.groupProperty attribute defined at extension solrfacetsearch.
      static java.lang.String INDEXEDTYPE
      Generated constant - Attribute key of SolrSearchQueryTemplate.indexedType attribute defined at extension solrfacetsearch.
      static java.lang.String INDEXEDTYPEPOS
      Generated constant - Attribute key of SolrSearchQueryTemplate.indexedTypePOS attribute defined at extension solrfacetsearch.
      static java.lang.String NAME
      Generated constant - Attribute key of SolrSearchQueryTemplate.name attribute defined at extension solrfacetsearch.
      static java.lang.String PAGESIZE
      Generated constant - Attribute key of SolrSearchQueryTemplate.pageSize attribute defined at extension solrfacetsearch.
      static java.lang.String RESTRICTFIELDSINRESPONSE
      Generated constant - Attribute key of SolrSearchQueryTemplate.restrictFieldsInResponse attribute defined at extension solrfacetsearch.
      static java.lang.String SEARCHQUERYPROPERTIES
      Generated constant - Attribute key of SolrSearchQueryTemplate.searchQueryProperties attribute defined at extension solrfacetsearch.
      static java.lang.String SEARCHQUERYSORTS
      Generated constant - Attribute key of SolrSearchQueryTemplate.searchQuerySorts attribute defined at extension solrfacetsearch.
      static java.lang.String SHOWFACETS
      Generated constant - Attribute key of SolrSearchQueryTemplate.showFacets attribute defined at extension solrfacetsearch.
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • _SOLRINDEXEDTYPE2SOLRSEARCHQUERYTEMPLATE

        public static final java.lang.String _SOLRINDEXEDTYPE2SOLRSEARCHQUERYTEMPLATE
        Generated relation code constant for relation SolrIndexedType2SolrSearchQueryTemplate defining source attribute indexedType in extension solrfacetsearch.
        See Also:
        Constant Field Values
      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of SolrSearchQueryTemplate.name attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • SHOWFACETS

        public static final java.lang.String SHOWFACETS
        Generated constant - Attribute key of SolrSearchQueryTemplate.showFacets attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • RESTRICTFIELDSINRESPONSE

        public static final java.lang.String RESTRICTFIELDSINRESPONSE
        Generated constant - Attribute key of SolrSearchQueryTemplate.restrictFieldsInResponse attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • ENABLEHIGHLIGHTING

        public static final java.lang.String ENABLEHIGHLIGHTING
        Generated constant - Attribute key of SolrSearchQueryTemplate.enableHighlighting attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • GROUP

        public static final java.lang.String GROUP
        Generated constant - Attribute key of SolrSearchQueryTemplate.group attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • GROUPPROPERTY

        public static final java.lang.String GROUPPROPERTY
        Generated constant - Attribute key of SolrSearchQueryTemplate.groupProperty attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • GROUPLIMIT

        public static final java.lang.String GROUPLIMIT
        Generated constant - Attribute key of SolrSearchQueryTemplate.groupLimit attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • GROUPFACETS

        public static final java.lang.String GROUPFACETS
        Generated constant - Attribute key of SolrSearchQueryTemplate.groupFacets attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • PAGESIZE

        public static final java.lang.String PAGESIZE
        Generated constant - Attribute key of SolrSearchQueryTemplate.pageSize attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • FTSQUERYBUILDER

        public static final java.lang.String FTSQUERYBUILDER
        Generated constant - Attribute key of SolrSearchQueryTemplate.ftsQueryBuilder attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • FTSQUERYBUILDERPARAMETERS

        public static final java.lang.String FTSQUERYBUILDERPARAMETERS
        Generated constant - Attribute key of SolrSearchQueryTemplate.ftsQueryBuilderParameters attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • INDEXEDTYPEPOS

        public static final java.lang.String INDEXEDTYPEPOS
        Generated constant - Attribute key of SolrSearchQueryTemplate.indexedTypePOS attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • INDEXEDTYPE

        public static final java.lang.String INDEXEDTYPE
        Generated constant - Attribute key of SolrSearchQueryTemplate.indexedType attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • SEARCHQUERYPROPERTIES

        public static final java.lang.String SEARCHQUERYPROPERTIES
        Generated constant - Attribute key of SolrSearchQueryTemplate.searchQueryProperties attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
      • SEARCHQUERYSORTS

        public static final java.lang.String SEARCHQUERYSORTS
        Generated constant - Attribute key of SolrSearchQueryTemplate.searchQuerySorts attribute defined at extension solrfacetsearch.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SolrSearchQueryTemplateModel

        public SolrSearchQueryTemplateModel()
        Generated constructor - Default constructor for generic creation.
      • SolrSearchQueryTemplateModel

        public SolrSearchQueryTemplateModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • SolrSearchQueryTemplateModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public SolrSearchQueryTemplateModel​(SolrIndexedTypeModel _indexedType,
                                            java.lang.String _name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _indexedType - initial attribute declared by type SolrSearchQueryTemplate at extension solrfacetsearch
        _name - initial attribute declared by type SolrSearchQueryTemplate at extension solrfacetsearch
      • SolrSearchQueryTemplateModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public SolrSearchQueryTemplateModel​(SolrIndexedTypeModel _indexedType,
                                            java.lang.String _name,
                                            ItemModel _owner)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _indexedType - initial attribute declared by type SolrSearchQueryTemplate at extension solrfacetsearch
        _name - initial attribute declared by type SolrSearchQueryTemplate at extension solrfacetsearch
        _owner - initial attribute declared by type Item at extension core
    • Method Detail

      • getFtsQueryBuilder

        @Accessor(qualifier="ftsQueryBuilder",
                  type=GETTER)
        public java.lang.String getFtsQueryBuilder()
        Generated method - Getter of the SolrSearchQueryTemplate.ftsQueryBuilder attribute defined at extension solrfacetsearch.
        Returns:
        the ftsQueryBuilder
      • getFtsQueryBuilderParameters

        @Accessor(qualifier="ftsQueryBuilderParameters",
                  type=GETTER)
        public java.util.Map<java.lang.String,​java.lang.String> getFtsQueryBuilderParameters()
        Generated method - Getter of the SolrSearchQueryTemplate.ftsQueryBuilderParameters attribute defined at extension solrfacetsearch.
        Returns:
        the ftsQueryBuilderParameters
      • getGroupLimit

        @Accessor(qualifier="groupLimit",
                  type=GETTER)
        public java.lang.Integer getGroupLimit()
        Generated method - Getter of the SolrSearchQueryTemplate.groupLimit attribute defined at extension solrfacetsearch.
        Returns:
        the groupLimit
      • getGroupProperty

        @Accessor(qualifier="groupProperty",
                  type=GETTER)
        public SolrIndexedPropertyModel getGroupProperty()
        Generated method - Getter of the SolrSearchQueryTemplate.groupProperty attribute defined at extension solrfacetsearch.
        Returns:
        the groupProperty
      • getIndexedType

        @Accessor(qualifier="indexedType",
                  type=GETTER)
        public SolrIndexedTypeModel getIndexedType()
        Generated method - Getter of the SolrSearchQueryTemplate.indexedType attribute defined at extension solrfacetsearch.
        Returns:
        the indexedType
      • getName

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName()
        Generated method - Getter of the SolrSearchQueryTemplate.name attribute defined at extension solrfacetsearch.
        Returns:
        the name
      • getPageSize

        @Accessor(qualifier="pageSize",
                  type=GETTER)
        public java.lang.Integer getPageSize()
        Generated method - Getter of the SolrSearchQueryTemplate.pageSize attribute defined at extension solrfacetsearch.
        Returns:
        the pageSize
      • getSearchQueryProperties

        @Accessor(qualifier="searchQueryProperties",
                  type=GETTER)
        public java.util.Collection<SolrSearchQueryPropertyModel> getSearchQueryProperties()
        Generated method - Getter of the SolrSearchQueryTemplate.searchQueryProperties attribute defined at extension solrfacetsearch. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the searchQueryProperties
      • getSearchQuerySorts

        @Accessor(qualifier="searchQuerySorts",
                  type=GETTER)
        public java.util.Collection<SolrSearchQuerySortModel> getSearchQuerySorts()
        Generated method - Getter of the SolrSearchQueryTemplate.searchQuerySorts attribute defined at extension solrfacetsearch. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the searchQuerySorts
      • isEnableHighlighting

        @Accessor(qualifier="enableHighlighting",
                  type=GETTER)
        public boolean isEnableHighlighting()
        Generated method - Getter of the SolrSearchQueryTemplate.enableHighlighting attribute defined at extension solrfacetsearch.
        Returns:
        the enableHighlighting
      • isGroup

        @Accessor(qualifier="group",
                  type=GETTER)
        public boolean isGroup()
        Generated method - Getter of the SolrSearchQueryTemplate.group attribute defined at extension solrfacetsearch.
        Returns:
        the group
      • isGroupFacets

        @Accessor(qualifier="groupFacets",
                  type=GETTER)
        public boolean isGroupFacets()
        Generated method - Getter of the SolrSearchQueryTemplate.groupFacets attribute defined at extension solrfacetsearch.
        Returns:
        the groupFacets
      • isRestrictFieldsInResponse

        @Accessor(qualifier="restrictFieldsInResponse",
                  type=GETTER)
        public boolean isRestrictFieldsInResponse()
        Generated method - Getter of the SolrSearchQueryTemplate.restrictFieldsInResponse attribute defined at extension solrfacetsearch.
        Returns:
        the restrictFieldsInResponse
      • isShowFacets

        @Accessor(qualifier="showFacets",
                  type=GETTER)
        public boolean isShowFacets()
        Generated method - Getter of the SolrSearchQueryTemplate.showFacets attribute defined at extension solrfacetsearch.
        Returns:
        the showFacets
      • setEnableHighlighting

        @Accessor(qualifier="enableHighlighting",
                  type=SETTER)
        public void setEnableHighlighting​(boolean value)
        Generated method - Setter of SolrSearchQueryTemplate.enableHighlighting attribute defined at extension solrfacetsearch.
        Parameters:
        value - the enableHighlighting
      • setFtsQueryBuilder

        @Accessor(qualifier="ftsQueryBuilder",
                  type=SETTER)
        public void setFtsQueryBuilder​(java.lang.String value)
        Generated method - Setter of SolrSearchQueryTemplate.ftsQueryBuilder attribute defined at extension solrfacetsearch.
        Parameters:
        value - the ftsQueryBuilder
      • setFtsQueryBuilderParameters

        @Accessor(qualifier="ftsQueryBuilderParameters",
                  type=SETTER)
        public void setFtsQueryBuilderParameters​(java.util.Map<java.lang.String,​java.lang.String> value)
        Generated method - Setter of SolrSearchQueryTemplate.ftsQueryBuilderParameters attribute defined at extension solrfacetsearch.
        Parameters:
        value - the ftsQueryBuilderParameters
      • setGroup

        @Accessor(qualifier="group",
                  type=SETTER)
        public void setGroup​(boolean value)
        Generated method - Setter of SolrSearchQueryTemplate.group attribute defined at extension solrfacetsearch.
        Parameters:
        value - the group
      • setGroupFacets

        @Accessor(qualifier="groupFacets",
                  type=SETTER)
        public void setGroupFacets​(boolean value)
        Generated method - Setter of SolrSearchQueryTemplate.groupFacets attribute defined at extension solrfacetsearch.
        Parameters:
        value - the groupFacets
      • setGroupLimit

        @Accessor(qualifier="groupLimit",
                  type=SETTER)
        public void setGroupLimit​(java.lang.Integer value)
        Generated method - Setter of SolrSearchQueryTemplate.groupLimit attribute defined at extension solrfacetsearch.
        Parameters:
        value - the groupLimit
      • setGroupProperty

        @Accessor(qualifier="groupProperty",
                  type=SETTER)
        public void setGroupProperty​(SolrIndexedPropertyModel value)
        Generated method - Setter of SolrSearchQueryTemplate.groupProperty attribute defined at extension solrfacetsearch.
        Parameters:
        value - the groupProperty
      • setIndexedType

        @Accessor(qualifier="indexedType",
                  type=SETTER)
        public void setIndexedType​(SolrIndexedTypeModel value)
        Generated method - Initial setter of SolrSearchQueryTemplate.indexedType attribute defined at extension solrfacetsearch. Can only be used at creation of model - before first save.
        Parameters:
        value - the indexedType
      • setName

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value)
        Generated method - Setter of SolrSearchQueryTemplate.name attribute defined at extension solrfacetsearch.
        Parameters:
        value - the name
      • setPageSize

        @Accessor(qualifier="pageSize",
                  type=SETTER)
        public void setPageSize​(java.lang.Integer value)
        Generated method - Setter of SolrSearchQueryTemplate.pageSize attribute defined at extension solrfacetsearch.
        Parameters:
        value - the pageSize
      • setRestrictFieldsInResponse

        @Accessor(qualifier="restrictFieldsInResponse",
                  type=SETTER)
        public void setRestrictFieldsInResponse​(boolean value)
        Generated method - Setter of SolrSearchQueryTemplate.restrictFieldsInResponse attribute defined at extension solrfacetsearch.
        Parameters:
        value - the restrictFieldsInResponse
      • setSearchQueryProperties

        @Accessor(qualifier="searchQueryProperties",
                  type=SETTER)
        public void setSearchQueryProperties​(java.util.Collection<SolrSearchQueryPropertyModel> value)
        Generated method - Setter of SolrSearchQueryTemplate.searchQueryProperties attribute defined at extension solrfacetsearch.
        Parameters:
        value - the searchQueryProperties
      • setSearchQuerySorts

        @Accessor(qualifier="searchQuerySorts",
                  type=SETTER)
        public void setSearchQuerySorts​(java.util.Collection<SolrSearchQuerySortModel> value)
        Generated method - Setter of SolrSearchQueryTemplate.searchQuerySorts attribute defined at extension solrfacetsearch.
        Parameters:
        value - the searchQuerySorts
      • setShowFacets

        @Accessor(qualifier="showFacets",
                  type=SETTER)
        public void setShowFacets​(boolean value)
        Generated method - Setter of SolrSearchQueryTemplate.showFacets attribute defined at extension solrfacetsearch.
        Parameters:
        value - the showFacets