Class JCREventHelper
java.lang.Object
org.ametys.plugins.repository.events.JCREventHelper
- All Implemented Interfaces:
Component
Helper for implementing
EventHolder
in JCR.-
Method Summary
Modifier and TypeMethodDescriptionstatic Node
addEventNode
(EventHolder eventHolder, Date eventDate, String eventType, UserIdentity author) Add an event nodestatic NodeIterator
getEvents
(EventHolder eventHolder) Returns the event child nodesstatic NodeIterator
getEvents
(EventHolder eventHolder, String[] types) Returns the events sorted by ascending datestatic Node
getEventsRootNode
(Node node) Get the node holding the JCR events under the given nodestatic String
getEventXPathQuery
(EventHolder eventHolder, Expression eventExpression, SortCriteria sortCriteria) Creates the XPath query corresponding to specifiedExpression
.
-
Method Details
-
getEventsRootNode
Get the node holding the JCR events under the given node- Parameters:
node
- The parent node- Returns:
- the events' root node
- Throws:
RepositoryException
- if an error occurred
-
getEvents
Returns the event child nodes- Parameters:
eventHolder
- The event holder- Returns:
- The event child nodes
- Throws:
RepositoryException
- if an error occurred
-
getEvents
public static NodeIterator getEvents(EventHolder eventHolder, String[] types) throws RepositoryException Returns the events sorted by ascending date- Parameters:
eventHolder
- The event holdertypes
- The types of events to return. Can benull
to get all events- Returns:
- The event child nodes
- Throws:
RepositoryException
- if an error occurred
-
getEventXPathQuery
public static String getEventXPathQuery(EventHolder eventHolder, Expression eventExpression, SortCriteria sortCriteria) throws RepositoryException Creates the XPath query corresponding to specifiedExpression
.- Parameters:
eventHolder
- the event holdereventExpression
- the query predicates.sortCriteria
- the sort criteria.- Returns:
- the created XPath query.
- Throws:
RepositoryException
- if an error occurred
-
addEventNode
public static Node addEventNode(EventHolder eventHolder, Date eventDate, String eventType, UserIdentity author) throws RepositoryException Add an event node- Parameters:
eventHolder
- The event holdereventDate
- The event's dateeventType
- The event's typeauthor
- The event's author- Returns:
- The created event node
- Throws:
RepositoryException
- if an error occurred
-