Package org.lfenergy.compas.sct.commons.scl.ied

Class DataSetAdapter

java.lang.Object

org.lfenergy.compas.sct.commons.scl.SclElementAdapter<AbstractLNAdapter<? extends TAnyLN>,TDataSet>

org.lfenergy.compas.sct.commons.scl.ied.DataSetAdapter

public class DataSetAdapter
extends SclElementAdapter<AbstractLNAdapter<? extends TAnyLN>,TDataSet>

A representation of the model object DataSetAdapter.

The following features are supported:

1. Principal functions
• look for a FCDA in this DataSet
• <em>create a FCDA in this DataSet</em></li> </ul> </ol> <br/> <pre> <b>ObjectReference</b>: DataSet <b>LDName</b> = "name" key of the DataSet in the parent LN/LN0 </pre>

See Also:

• TLN0
• AbstractLNAdapter

Field Summary

Fields inherited from class org.lfenergy.compas.sct.commons.scl.SclElementAdapter

currentElem, parentAdapter

Constructor Summary

Constructors

Constructor	Description
DataSetAdapter(AbstractLNAdapter<? extends TAnyLN> parentAdapter, TDataSet dataSet)

Method Summary

Modifier and Type	Method	Description
protected boolean	amChildElementRef()	Check if node is child of the reference node
TFCDA	createFCDAIfNotExists(String ldInst, String prefix, String lnClass, String lnInst, String doName, String daName, TFCEnum fc)	Create a new FCDA in this DataSet.
protected String	elementXPath()	Returns local XPath
Optional<TFCDA>	findFCDA(String ldInst, String prefix, String lnClass, String lnInst, String doName, String daName, TFCEnum fc)	Find a FCDA matching all given criteria.

Methods inherited from class org.lfenergy.compas.sct.commons.scl.SclElementAdapter

addPrivate, amRootElement, buildFatalReportItem, customInit, getXPath, setCurrentElem

Methods inherited from class java.lang.Object

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

Constructor Details

DataSetAdapter

public DataSetAdapter(AbstractLNAdapter<? extends TAnyLN> parentAdapter,
 TDataSet dataSet)

Method Details

amChildElementRef

protected boolean amChildElementRef()

Check if node is child of the reference node

Specified by:

amChildElementRef in class SclElementAdapter<AbstractLNAdapter<? extends TAnyLN>,TDataSet>

Returns:

link parent child existence

elementXPath

protected String elementXPath()

Returns local XPath

Specified by:

elementXPath in class SclElementAdapter<AbstractLNAdapter<? extends TAnyLN>,TDataSet>

Returns:

XPath for current element (not including parent XPath)

findFCDA

public Optional<TFCDA> findFCDA(String ldInst,
 String prefix,
 String lnClass,
 String lnInst,
 String doName,
 String daName,
 TFCEnum fc)

Find a FCDA matching all given criteria.

Parameters:

ldInst - FCDA ldInst attribute

prefix - FCDA prefix attribute

lnClass - FCDA lnClass attribute

lnInst - FCDA lnInst attribute

doName - FCDA doName attribute

daName - FCDA daNae attribute

fc - FCDA fc attribute

Returns:

Matching FCDA in this DataSet when found, empty Optional otherwise.

createFCDAIfNotExists

public TFCDA createFCDAIfNotExists(String ldInst,
 String prefix,
 String lnClass,
 String lnInst,
 String doName,
 String daName,
 TFCEnum fc)

Create a new FCDA in this DataSet. Does nothing if a FCDA with the given attribute already exists in this DataSet.

Parameters:

ldInst - FCDA ldInst attribute

prefix - FCDA prefix attribute

lnClass - FCDA lnClass attribute

lnInst - FCDA lnInst attribute

doName - FCDA doName attribute

daName - FCDA daNae attribute

fc - FCDA fc attribute

Returns:

created FCDA, or existing FCDA with the given attributes