Package com.inductiveautomation.historian.gateway.api.paths

Interface QualifiedPathAdapter

All Known Implementing Classes:

StandardHistorianPathAdapter, SysOmittingHistorianPathAdapter

public interface QualifiedPathAdapter

Represents an adapter for processing and normalizing QualifiedPath objects. A QualifiedPathAdapter provides a mechanism to adapt a QualifiedPath to an AdaptedQualifiedPath, which may involve modifying or validating the path based on specific implementation rules.

Field Summary

Fields

Modifier and Type	Field	Description
static final QualifiedPathAdapter	DEFAULT

Method Summary

Modifier and Type	Method	Description
AdaptedQualifiedPath	normalize(QualifiedPath path)	Normalizes the given QualifiedPath and returns an AdaptedQualifiedPath.

Field Details

DEFAULT

static final QualifiedPathAdapter DEFAULT

Method Details

normalize

AdaptedQualifiedPath normalize(QualifiedPath path)
                        throws InvalidQualifiedPathException

Normalizes the given QualifiedPath and returns an AdaptedQualifiedPath. The normalization process may involve validating or modifying the input path according to specific implementation rules.

Parameters:

path - the QualifiedPath to normalize

Returns:

the resulting AdaptedQualifiedPath after normalization

Throws:

InvalidQualifiedPathException - if the provided QualifiedPath is invalid