Class TextsearchQueryNode


  • public class TextsearchQueryNode
    extends QueryNode
    Implements a query node that defines a textsearch clause.
    • Constructor Detail

      • TextsearchQueryNode

        protected TextsearchQueryNode​(QueryNode parent,
                                      String query)
        Creates a new TextsearchQueryNode with a parent and a textsearch query statement. The scope of the query is the fulltext index of the node, that contains all properties.
        Parameters:
        parent - the parent node of this query node.
        query - the textsearch statement.
    • Method Detail

      • getType

        public int getType()
        Returns the type of this node.
        Specified by:
        getType in class QueryNode
        Returns:
        the type of this node.
      • getQuery

        public String getQuery()
        Returns the textsearch statement.
        Returns:
        the textsearch statement.
      • getPropertyName

        public Name getPropertyName()
        Deprecated.
        Use getRelativePath() instead.
        Returns a property name if the scope is limited to just a single property or null if the scope is spawned across all properties of a node. Please note that this method does not return the full relative path that reference the item to match, but only the name of the final name element of the path returned by getRelativePath().
        Returns:
        property name or null.
      • setPropertyName

        public void setPropertyName​(Name property)
        Deprecated.
        Sets a new name as the search scope for this fulltext query.
        Parameters:
        property - the name of the property.
      • getRelativePath

        public Path getRelativePath()
        Returns:
        the relative path that references the item where the textsearch is performed. Returns null if the textsearch is performed on the context node.
      • setRelativePath

        public void setRelativePath​(Path relPath)
        Sets the relative path to the item where the textsearch is performed. If relPath is null the textsearch is performed on the context node.
        Parameters:
        relPath - the relative path to an item.
        Throws:
        IllegalArgumentException - if relPath is absolute.
      • addPathElement

        public void addPathElement​(Path.Element element)
        Adds a path element to the existing relative path. To add a path element which matches all node names use RelationQueryNode.STAR_NAME_TEST.
        Parameters:
        element - the path element to append.
      • getReferencesProperty

        public boolean getReferencesProperty()
        Returns:
        true if getRelativePath() references a property, returns false if it references a node.
      • setReferencesProperty

        public void setReferencesProperty​(boolean b)
        Is set to true, indicates that getRelativePath() references a property, if set to false indicates that it references a node.
        Parameters:
        b - flag whether a property is referenced.
      • equals

        public boolean equals​(Object obj)
        Returns true if obj is the same type of QueryNode as this node and is equal to this node.
        Specified by:
        equals in class QueryNode
        Parameters:
        obj - the reference object with which to compare.
        Returns:
        true if obj is equal to this; false otherwise.
      • needsSystemTree

        public boolean needsSystemTree()
        Returns true if this query node needs items under /jcr:system to be queried.
        Specified by:
        needsSystemTree in class QueryNode
        Returns:
        true if this query node needs content under /jcr:system to be queried; false otherwise.