Package com.powsybl.security

Class SecurityAnalysisResultBuilder

java.lang.Object

com.powsybl.security.SecurityAnalysisResultBuilder

public class SecurityAnalysisResultBuilder
extends Object

Facilitates the creation of security analysis results.

Encapsulates filtering of limit violations with a provided LimitViolationFilter, as well as notifications to SecurityAnalysisInterceptors.

Author:

Sylvain Leclerc

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SecurityAnalysisResultBuilder.AbstractLimitViolationsResultBuilder<B extends SecurityAnalysisResultBuilder.AbstractLimitViolationsResultBuilder<B>>	Base class for the pre and post contingency builders.
class	SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder
class	SecurityAnalysisResultBuilder.PostContingencyResultBuilder
class	SecurityAnalysisResultBuilder.PreContingencyResultBuilder	Builder for the pre-contingency result

Constructor Summary

Constructors

Constructor	Description
SecurityAnalysisResultBuilder(LimitViolationFilter filter, SecurityAnalysisResultContext context)
SecurityAnalysisResultBuilder(LimitViolationFilter filter, SecurityAnalysisResultContext context, Collection<SecurityAnalysisInterceptor> interceptors)

Method Summary

Modifier and Type	Method	Description
SecurityAnalysisResult	build()	Finalizes the result.
SecurityAnalysisResultBuilder.PostContingencyResultBuilder	contingency(Contingency contingency)	Initiates the creation of the result for one Contingency.
SecurityAnalysisResultBuilder.PostContingencyResultBuilder	contingency(Contingency contingency, SecurityAnalysisResultContext postContingencyResultContext)	Initiates the creation of the result for one Contingency
SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder	operatorStrategy(OperatorStrategy strategy)	Initiates the creation of the result for one OperatorStrategy.
SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder	operatorStrategy(OperatorStrategy strategy, SecurityAnalysisResultContext strategyContext)	Initiates the creation of the result for one OperatorStrategy.
SecurityAnalysisResultBuilder.PreContingencyResultBuilder	preContingency()	Initiates the creation of the result for N situation.
SecurityAnalysisResultBuilder.PreContingencyResultBuilder	preContingency(SecurityAnalysisResultContext preContingencyResultContext)	Initiates the creation of the result for N situation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityAnalysisResultBuilder

public SecurityAnalysisResultBuilder(LimitViolationFilter filter,
                                     SecurityAnalysisResultContext context,
                                     Collection<SecurityAnalysisInterceptor> interceptors)

SecurityAnalysisResultBuilder

public SecurityAnalysisResultBuilder(LimitViolationFilter filter,
                                     SecurityAnalysisResultContext context)

Method Detail

preContingency

public SecurityAnalysisResultBuilder.PreContingencyResultBuilder preContingency()

Initiates the creation of the result for N situation.

Returns:

a SecurityAnalysisResultBuilder.PreContingencyResultBuilder instance.

preContingency

public SecurityAnalysisResultBuilder.PreContingencyResultBuilder preContingency(SecurityAnalysisResultContext preContingencyResultContext)

Initiates the creation of the result for N situation

Parameters:

preContingencyResultContext - the context used when create the result

Returns:

a SecurityAnalysisResultBuilder.PreContingencyResultBuilder instance.

contingency

public SecurityAnalysisResultBuilder.PostContingencyResultBuilder contingency(Contingency contingency)

Initiates the creation of the result for one Contingency.

Parameters:

contingency - the contingency for which a result should be created

Returns:

a SecurityAnalysisResultBuilder.PostContingencyResultBuilder instance.

contingency

public SecurityAnalysisResultBuilder.PostContingencyResultBuilder contingency(Contingency contingency,
                                                                              SecurityAnalysisResultContext postContingencyResultContext)

Initiates the creation of the result for one Contingency

Parameters:

contingency - the contingency for which a result should be created

postContingencyResultContext - the context used when create the result

Returns:

a SecurityAnalysisResultBuilder.PostContingencyResultBuilder instance.

operatorStrategy

public SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder operatorStrategy(OperatorStrategy strategy)

Initiates the creation of the result for one OperatorStrategy.

Parameters:

strategy - the operator strategy for which a result should be created

Returns:

a SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder instance.

operatorStrategy

public SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder operatorStrategy(OperatorStrategy strategy,
                                                                                    SecurityAnalysisResultContext strategyContext)

Initiates the creation of the result for one OperatorStrategy.

Parameters:

strategy - the operator strategy for which a result should be created

Returns:

a SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder instance.

build

public SecurityAnalysisResult build()

Finalizes the result.

Returns:

the N situation result builder