Package org.hippoecm.hst.provider

Interface ValueProvider

All Superinterfaces:
Serializable
All Known Subinterfaces:
JCRValueProvider
public interface ValueProvider extends Serializable

  • Method Details

    • getPath

      String getPath()
      Returns:
      the path of the object used to create this valueprovider with

    • getCanonicalPath

      String getCanonicalPath()
      The canonical path can be a different location then getPath() because the latter might give some virtual / mirrored path of the value provider
      Returns:
      the canonical path of the object used to create this valueprovider with

    • getIdentifier

      String getIdentifier()
      Returns:
      the identifier of the object used to create this valueprovider with

    • getName

      String getName()
      Returns:
      the name of the object used to create this valueprovider with

    • hasProperty

      boolean hasProperty(String propertyName)
      Method returning true when the jcr node has the property
      Parameters:
      propertyName -
      Returns:
      true if the node has the propertyName

    • getString

      String getString(String propertyName)
      Returns the string value of a node property
      Parameters:
      propertyName -
      Returns:
      String value of the node property, or null if the property does not exist, or is multivalued, or is not of type string

    • getStrings

      String[] getStrings(String propertyName)
      Returns String array of string values of a node property
      Parameters:
      propertyName -
      Returns:
      String[] values of the node property, or an empty string array String[0] if the property does not exist, or is single-valued, or is not of type string

    • getBoolean

      Boolean getBoolean(String propertyName)
      Returns the boolean value of a node property
      Parameters:
      propertyName -
      Returns:
      Boolean value of the node property. If the property does not exist, or is multivalued, or is not of type boolean, false is returned

    • getBooleans

      Boolean[] getBooleans(String propertyName)
      Returns boolean array of the boolean values of a node property
      Parameters:
      propertyName -
      Returns:
      Boolean[] values of the node property. If the property does not exist, or is single-valued, or is not of type boolean, an empty boolean array Boolean[0] is returned

    • getLong

      Long getLong(String propertyName)
      Returns the long value of a node property.
      Parameters:
      propertyName -
      Returns:
      Long value of the node property. If the property does not exist, or is multivalued, or is not of type long, 0 is returned

    • getLongs

      Long[] getLongs(String propertyName)
      Returns long array of the long values of a node property.
      Parameters:
      propertyName -
      Returns:
      Long array presentation of the node property. If the property does not exist, or is single-valued, or is not of type long, an empty array Long[0] is returned

    • getDouble

      Double getDouble(String propertyName)
      Returns the double value of a node property.
      Parameters:
      propertyName -
      Returns:
      Double value of the node property. If the property does not exist, or is multivalued, or is not of type double, 0 is returned

    • getDoubles

      Double[] getDoubles(String propertyName)
      Returns double array of the long values of a node property.
      Parameters:
      propertyName -
      Returns:
      Double array presentation of the node property. If the property does not exist, or is single-valued, or is not of type double, an empty array Double[0] is returned

    • getDate

      Calendar getDate(String propertyName)
      Returns the Calendar value of a node property.
      Parameters:
      propertyName -
      Returns:
      Calendar value of the node property. If the property does not exist, or is multivalued, or is not of type jcr DATE, null is returned

    • getDates

      Calendar[] getDates(String propertyName)
      Returns Calendar array of the Calendar values of a node property.
      Parameters:
      propertyName -
      Returns:
      Calendar[] of the Calendar values of the node property. If the property does not exist, or is single-valued, or is not of type jcr DATE, an empty array Calendar[0] is returned

    • getPropertyMap

      PropertyMap getPropertyMap()
      Returns all combined properties that are of type String, boolean, int, long, double or Calendar in a PropertyMap.

    • getProperties

      Map<String,Object> getProperties()
      Returns all combined properties that are of type String, boolean, int, long, double or Calendar in a Map.