Package step.core.artefacts.reports

Interface ReportNodeAccessor

All Superinterfaces:

step.core.accessors.Accessor<ReportNode>, ReportTreeAccessor

All Known Implementing Classes:

InMemoryReportNodeAccessor, ReportNodeAccessorImpl

public interface ReportNodeAccessor
extends step.core.accessors.Accessor<ReportNode>, ReportTreeAccessor

Method Summary

Modifier and Type	Method	Description
void	createIndexesIfNeeded(Long ttl)
Iterator<ReportNode>	getChildren(String parentID)	Returns the list of children of the ReportNode
Iterator<ReportNode>	getChildren(org.bson.types.ObjectId parentID)
Iterator<ReportNode>	getChildren(org.bson.types.ObjectId parentID, int skip, int limit)
ReportNode	getReportNodeByParentIDAndArtefactID(org.bson.types.ObjectId parentID, org.bson.types.ObjectId artefactID)
List<ReportNode>	getReportNodePath(org.bson.types.ObjectId id)
Stream<ReportNode>	getReportNodesByExecutionID(String executionID)	Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.
Stream<ReportNode>	getReportNodesByExecutionIDAndClass(String executionID, String class_)	Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.
Stream<ReportNode>	getReportNodesByExecutionIDAndCustomAttribute(String executionID, Map<String,String> customAttributes)	Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.
ReportNode	getRootReportNode(String executionID)
void	removeNodesByExecutionID(String executionID)

Methods inherited from interface step.core.accessors.Accessor

enableVersioning, findByAttributes, findByAttributes, findByCriteria, findManyByAttributes, findManyByAttributes, findManyByCriteria, get, get, getAll, getCollectionDriver, getHistory, getRange, isVersioningEnabled, remove, restoreVersion, save, save, stream, streamLazy

Methods inherited from interface step.core.artefacts.reports.ReportTreeAccessor

get, getReportNodesWithContributingErrors

Method Details

createIndexesIfNeeded

void createIndexesIfNeeded(Long ttl)

getReportNodePath

List<ReportNode> getReportNodePath(org.bson.types.ObjectId id)

getChildren

Iterator<ReportNode> getChildren(org.bson.types.ObjectId parentID)

getChildren

Iterator<ReportNode> getChildren(org.bson.types.ObjectId parentID,
 int skip,
 int limit)

getReportNodesByExecutionID

Stream<ReportNode> getReportNodesByExecutionID(String executionID)

Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.

Parameters:

executionID - the id of the execution

Returns:

a Stream with all report nodes of this execution

getReportNodesByExecutionIDAndClass

Stream<ReportNode> getReportNodesByExecutionIDAndClass(String executionID,
 String class_)

Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.

Parameters:

executionID - the id of the execution

class_ - the _class of the report node

Returns:

a Stream with all report nodes of this execution with type class_

getReportNodesByExecutionIDAndCustomAttribute

Stream<ReportNode> getReportNodesByExecutionIDAndCustomAttribute(String executionID,
 Map<String,String> customAttributes)

Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.

Parameters:

executionID - the id of the execution

customAttributes - filter on customer attributes

Returns:

a Stream with all report nodes of this execution matching provided custom attributes

getReportNodeByParentIDAndArtefactID

ReportNode getReportNodeByParentIDAndArtefactID(org.bson.types.ObjectId parentID,
 org.bson.types.ObjectId artefactID)

getRootReportNode

ReportNode getRootReportNode(String executionID)

getChildren

Iterator<ReportNode> getChildren(String parentID)

Description copied from interface: ReportTreeAccessor

Returns the list of children of the ReportNode

Specified by:

getChildren in interface ReportTreeAccessor

Parameters:

parentID - the ID of the parent ReportNode

Returns:

an Iterator of the list of children

removeNodesByExecutionID

void removeNodesByExecutionID(String executionID)