Class ComplianceObjective

java.lang.Object

com.eqixiac.equinix.design.objective.ComplianceObjective

All Implemented Interfaces:

Objective

public final class ComplianceObjective
extends Object
implements Objective

Share of (metro, stated zone) pairs the portfolio satisfies, 0 to 100: a metro satisfies a ComplianceZone when its region is one the zone allows, and a geoZones entry when the live catalogue lists the metro in that zone. 100 when the spec states no zone. The matching constraints enforce the hard version, so among feasible designs this only separates options when a constraint is relaxed (sensitivity analysis) or a plug-in replaces the constraints.

Field Summary

Fields inherited from interface Objective

COMPLIANCE, COST, LATENCY, PROVIDER_COVERAGE, RESILIENCE

Modifier and Type	Field	Description
static final String	COMPLIANCE	Share of the stated compliance and sovereignty zones the portfolio satisfies, 0 to 100.
static final String	COST	Total monthly cost of the portfolio in the spec's currency.
static final String	LATENCY	Site-weighted round-trip latency from the sites to their nearest metro in the portfolio, in ms.
static final String	PROVIDER_COVERAGE	Share of the required clouds and service providers reachable from the portfolio, 0 to 100.
static final String	RESILIENCE	How well the portfolio survives losing a metro or a region, 0 to 100.

Constructor Summary

Constructors

Constructor	Description
ComplianceObjective()

Method Summary

Modifier and Type	Method	Description
Direction	direction()
ObjectiveValue	evaluate(MetroPortfolio portfolio, DesignContext context)	Measures a portfolio.
String	id()
ValueScale	scale(DesignContext context)	A percentage is its own score.
String	unit()

Methods inherited from class Object

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

Constructor Details

ComplianceObjective

public ComplianceObjective()

Method Details

id

public String id()

Specified by:

id in interface Objective

Returns:

the id weights refer to (for example Objective.LATENCY); stable, lower_snake_case

direction

public Direction direction()

Specified by:

direction in interface Objective

Returns:

whether smaller or larger values are better

scale

public ValueScale scale(DesignContext context)

A percentage is its own score.

Specified by:

scale in interface Objective

Parameters:

context - the facts of this run

Returns:

the scale

unit

public String unit()

Specified by:

unit in interface Objective

Returns:

the unit of ObjectiveValue.value(), for display (for example ms, USD/month, score)

evaluate

public ObjectiveValue evaluate(MetroPortfolio portfolio,
 DesignContext context)

Description copied from interface: Objective

Measures a portfolio.

Specified by:

evaluate in interface Objective

Parameters:

portfolio - the metros of one candidate design

context - the facts of this run

Returns:

the measurement, or ObjectiveValue.unknown(String) when it cannot be made