PropertyProvider

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> slide >> [ search overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.slide.search.PropertyProvider

SOURCE |

Download org.apache.slide.search.PropertyProvider

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.slide.search
Interface PropertyProvider

public interface PropertyProvider

If a PropertyProvider is passed to Search.createSearchQuery() 55 , the Search helper must not access any of the properties supported by this PropertyProvider 55 directly (e.g. by using the Content helper) but instead use getProperty() 55 on this provider to retrieve it.

Version:: $Revision: 1.3 $

Method Summary

org.apache.slide.content.NodeProperty getProperty(java.lang.String resourceUri, java.lang.String propertyName, java.lang.String propertyNamespace)
          If the property specified by propertyNamespace and propertyName is supported by this PropertyProvider 55 , the NodeProperty of the resource located at the given resourceUri will be returned.

java.util.Iterator getSupportedProperties(java.lang.String resourceUri)
          Returns an Iterator of all NodeProperties supported by this PropertyProvider.

java.util.Iterator getSupportedPropertiesNames(java.lang.String resourceUri)
          Returns an Iterator of PropertyName of all properties supported by this PropertyProvider.

boolean isSupportedProperty(java.lang.String resourceUri, java.lang.String propertyName, java.lang.String propertyNamespace)
          Returns true if this PropertyProvider can provide the NodeProperty specified by propertyNamespace and propertyName for the resource with the given resourceUri.

Method Detail

isSupportedProperty

public boolean isSupportedProperty(java.lang.String resourceUri,
                                   java.lang.String propertyName,
                                   java.lang.String propertyNamespace)
                            throws org.apache.slide.common.SlideException

Returns true if this PropertyProvider can provide the NodeProperty specified by propertyNamespace and propertyName for the resource with the given resourceUri.

getSupportedPropertiesNames

public java.util.Iterator getSupportedPropertiesNames(java.lang.String resourceUri)
                                               throws org.apache.slide.common.SlideException

Returns an Iterator of PropertyName of all properties supported by this PropertyProvider.

getProperty

public org.apache.slide.content.NodeProperty getProperty(java.lang.String resourceUri,
                                                         java.lang.String propertyName,
                                                         java.lang.String propertyNamespace)
                                                  throws org.apache.slide.common.SlideException

If the property specified by propertyNamespace and propertyName is supported by this PropertyProvider 55 , the NodeProperty of the resource located at the given resourceUri will be returned. Otherwise null is returned.

getSupportedProperties

public java.util.Iterator getSupportedProperties(java.lang.String resourceUri)
                                          throws org.apache.slide.common.SlideException

Returns an Iterator of all NodeProperties supported by this PropertyProvider.