Interface JcrIndexPropertyService


  • public interface JcrIndexPropertyService
    This service facilitates adding custom indexable properties to the index. Indexable properties are properties of JCR nodes which are included in the JCR index (contained by the table wmJcrIndexproperties). The indexable properties can be used in queries of the JcrIndexQueryManager (see JcrIndexQueryManager.getNodes(Session, String, Map) for optimal performance.
    Since:
    10.31.0
    • Method Detail

      • getIndexedProperties

        List<String> getIndexedProperties()
                                   throws javax.jcr.RepositoryException
        Returns a list of the names of the current indexable properties.
        Returns:
        List of property names of each available indexable property
        Throws:
        javax.jcr.RepositoryException - In case the array of indexable properties could not be determined due to an error
      • isIndexedProperty

        boolean isIndexedProperty​(String propertyName)
                           throws javax.jcr.RepositoryException
        Returns true if an indexable property exists with the specified property name.
        Parameters:
        propertyName - Name of the property to check
        Returns:
        true if an indexable property exists with the specified property name, false otherwise
        Throws:
        javax.jcr.RepositoryException - In case the check resulted in an error
      • addIndexedProperty

        void addIndexedProperty​(JcrIndexedProperty property)
                         throws javax.jcr.RepositoryException
        Appends an indexable property to the JCR index, if it is not already adde. This method does nothing if the indexable property is already added.
        Parameters:
        property - The indexable property to append.
        Throws:
        javax.jcr.RepositoryException - In case the indexable property could not be appended to the index due to an error.
      • removeIndexedProperty

        void removeIndexedProperty​(JcrIndexedProperty property)
                            throws javax.jcr.RepositoryException
        Removed an indexable property from the JCR index.
        Parameters:
        property - The indexable property to remove.
        Throws:
        javax.jcr.RepositoryException