JCRValueProvider (Hippo Site Toolkit API 15.2.0 API)

All Superinterfaces:: Serializable, ValueProvider

public interface JCRValueProvider
extends ValueProvider

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`detach()`	Method for detaching the jcr node.
`void`	`flush()`	Flushes all fetched data kept in instance variables
`String`	`getDisplayName()`
`javax.jcr.Node`	`getJcrNode()`	returns the `Node` that was used to create this value provider with or `null` when the node is already detached
`javax.jcr.Node`	`getParentJcrNode()`	returns the parent `Node` of this value provider or `null` when the node is detached.
`boolean`	`isDetached()`	Test whether the jcr node is detached or not
`boolean`	`isNodeType(String nodeType)`

Methods inherited from interface org.hippoecm.hst.provider.ValueProvider
getBoolean, getBooleans, getCanonicalPath, getDate, getDates, getDouble, getDoubles, getIdentifier, getLong, getLongs, getName, getPath, getProperties, getPropertyMap, getString, getStrings, hasProperty

- Method Detail
  - getJcrNode
```
javax.jcr.Node getJcrNode()
```
    returns the Node that was used to create this value provider with or null when the node is already detached
    
    Returns:
    
    the jcr node
  - getDisplayName
```
String getDisplayName()
```
    Returns:
    
    the display name of the backing jcr node according to HippoNode.getDisplayName()
  - getParentJcrNode
```
javax.jcr.Node getParentJcrNode()
```
    returns the parent Node of this value provider or null when the node is detached. If the node is the jcr rootNode, null will be returned
    
    Returns:
    
    the parent Node or null if the node is null or there is no parent
  - detach
```
void detach()
```
    Method for detaching the jcr node. After calling this method, the jcr node is not available anymore
  - isDetached
```
boolean isDetached()
```
    Test whether the jcr node is detached or not
    
    Returns:
    
    true if the node is detached
  - isNodeType
```
boolean isNodeType(String nodeType)
```
    Parameters:
    
    nodeType -
    
    Returns:
    
    true when the underlying jcr node is of type nodeType
  - flush
```
void flush()
```
    Flushes all fetched data kept in instance variables