Package net.simplace.sim.transformers

Klasse SoilLayerTransformerLegacy

java.lang.Object
net.simplace.sim.io.FWSimIOAdapter
net.simplace.sim.io.resources.FWSimInputAdapter
net.simplace.sim.io.resources.FWSimResourceTransformer
net.simplace.sim.transformers.SoilLayerTransformerLegacy
Alle implementierten Schnittstellen:
net.simplace.sim.util.FWSimFieldContainer
public class SoilLayerTransformerLegacy extends net.simplace.sim.io.resources.FWSimResourceTransformer

Takes data with n depth depended layers and creates m layers with the same information

Description

Soil data is mostly delivered with the layer specific information. The layers have different depth and are varying in their count. This Transformer takes the data with these n different depth layers and creates layercount layers data with uniform thickness.

Either the layercount or the layerthickness can be defined to specify the output data resolution. The depthfield signifies the source field id with the depth information. Default is depth.

Output will be written as follows: Scalar field types like CHAR,DOUBLE,INT,... are kept as they are Array fields like DOUBLEARRAY and INTARRAY are transformed to the new array size concerning to layercount or layerthickness

Configuration

requested structure of configuration element:

| <transform id="soil_transform" interface="simpool" resource="soil" source="vSoiltype"
|     class="net.simplace.sim.transformers.SoilLayerTransformer" >
|      <header>
|        <res id="soiltype" datatype="CHAR"  key="vSoiltype" />
|        <res id="dampingdepth" unit="m" datatype="DOUBLE"/>
|        <res id="soilwater_fc_global" unit="cm3*cm-3" datatype="DOUBLE"/>
|         ...
|        <res id="clay" unit="g/100g" datatype="DOUBLEARRAY"/>
|        <res id="carbon" unit="g/100g" datatype="DOUBLEARRAY"/>
|      </header>
|      <input id="layercount" />
|      <input id="layerthickness">0.03</input>
|      <input id="depthfieldid">depth</input>
| </transform>
Autor:
Andreas Enders

Component Variables

Content TypeNameDescriptionData TypeUnitMin ValueMax ValueDefault Value
constantdepthfieldid-CHAR--
constantlayercount-INT1200-
constantlayerthickness-DOUBLEm1.0E-45.00.03

  • Verschachtelte Klassen - Übersicht

    Von Klasse geerbte verschachtelte Klassen/Schnittstellen net.simplace.sim.io.FWSimIOAdapter

    net.simplace.sim.io.FWSimIOAdapter.FREQUENCE

  • Feldübersicht

    Von Klasse geerbte Felder net.simplace.sim.io.resources.FWSimResourceTransformer

    iFieldMap, iIntColumnMap, iLastInputValuesMap, iLastProjectID, iLastUniqueID, iPoolName, iSourceName

    Von Klasse geerbte Felder net.simplace.sim.io.resources.FWSimInputAdapter

    iJexlScript, iShouldCacheToDB

    Von Klasse geerbte Felder net.simplace.sim.io.FWSimIOAdapter

    iArrayMode, iFieldcount, iFrequence, iHeaderVariables, iInterface, iJexlRule, iKeyMap, iName, iOrderNumber, iProcessTime, iResourceElement, iSession, iSourceKey

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    SoilLayerTransformerLegacy()
    used for ClassForName
    SoilLayerTransformerLegacy(net.simplace.sim.FWSimSession aSession, Integer aOrderNumber)
     
    SoilLayerTransformerLegacy(net.simplace.sim.FWSimSession aSession, org.jdom2.Element aResourceElement, Integer aOrderNumber)
     

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    HashMap<String,net.simplace.sim.util.FWSimVariable<?>>
    createVariables()
     
    net.simplace.sim.io.resources.FWSimResourceCache
    getData(net.simplace.sim.util.FWSimVarMap aVarMap)
    standard method from outside
    net.simplace.sim.io.resources.FWSimResourceCache
    getData(net.simplace.sim.util.FWSimVarMap aVarMap, net.simplace.sim.io.resources.FWSimResourceCache aResourceCache)
    used by test cases
    net.simplace.sim.io.resources.FWSimResourceCache
    reScaleSoilLayers(net.simplace.sim.util.FWSimVariable<Double> aThicknessOfLayers, net.simplace.sim.util.FWSimVariable<Integer> aLayerCount, net.simplace.sim.util.FWSimVariable<String> aDepthFieldName, String aProjectID, net.simplace.sim.io.resources.FWSimResourceCache aCache)
    Rescales the soil layer
    void
    updateFields(net.simplace.core.FWObservable aObservable)
     

    Von Klasse geerbte Methoden net.simplace.sim.io.resources.FWSimResourceTransformer

    addVariable, createFormFields, createResourceTransformer, createResourceTransformer, createResourceTransformer, createSimTransformer, fillVarMap, getCreateFormXML, getEditFormXML, getSourceResourceCache, getVariable, isUpdated, toDocXML, toXML

    Von Klasse geerbte Methoden net.simplace.sim.io.resources.FWSimInputAdapter

    getContentType, getInputVariables, getJexlScript, getOutputVariables, getVarMap, isTransformer, shouldCacheToDB, toHTMLTablestring

    Von Klasse geerbte Methoden net.simplace.sim.io.FWSimIOAdapter

    addProcessTime, checkCondition, createFormFields, finalize, getFieldMap, getFrequence, getHeaderVariables, getHeaderXML, getInterface, getJexlRule, getKeyMap, getName, getOrderNumber, isArrayMode, isConditionCheck, removeVariable, setInterface, setOrderNumber, toString, writeHeaderList

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • SoilLayerTransformerLegacy

      public SoilLayerTransformerLegacy(net.simplace.sim.FWSimSession aSession, org.jdom2.Element aResourceElement, Integer aOrderNumber)
      Parameter:
      aSession -
      aResourceElement -
      aOrderNumber -

    • SoilLayerTransformerLegacy

      public SoilLayerTransformerLegacy(net.simplace.sim.FWSimSession aSession, Integer aOrderNumber)
      Parameter:
      aSession -
      aOrderNumber -

    • SoilLayerTransformerLegacy

      public SoilLayerTransformerLegacy()
      used for ClassForName

  • Methodendetails

    • createVariables

      public HashMap<String,net.simplace.sim.util.FWSimVariable<?>> createVariables()
      Angegeben von:
      createVariables in Schnittstelle net.simplace.sim.util.FWSimFieldContainer
      Setzt außer Kraft:
      createVariables in Klasse net.simplace.sim.io.FWSimIOAdapter

    • getData

      public net.simplace.sim.io.resources.FWSimResourceCache getData(net.simplace.sim.util.FWSimVarMap aVarMap) throws net.simplace.sim.exceptions.MissingSimResourceException
      standard method from outside
      Angegeben von:
      getData in Klasse net.simplace.sim.io.resources.FWSimInputAdapter
      Löst aus:
      net.simplace.sim.exceptions.MissingSimResourceException
      Siehe auch:
      • FWSimInputAdapter.getData(net.simplace.sim.util.FWSimVarMap)

    • getData

      public net.simplace.sim.io.resources.FWSimResourceCache getData(net.simplace.sim.util.FWSimVarMap aVarMap, net.simplace.sim.io.resources.FWSimResourceCache aResourceCache) throws net.simplace.sim.exceptions.MissingSimResourceException
      used by test cases
      Parameter:
      aVarMap - variable map
      aResourceCache - Cached resources (soil data)
      Gibt zurück:
      delivered new data from transformer
      Löst aus:
      net.simplace.sim.exceptions.MissingSimResourceException

    • reScaleSoilLayers

      public net.simplace.sim.io.resources.FWSimResourceCache reScaleSoilLayers(net.simplace.sim.util.FWSimVariable<Double> aThicknessOfLayers, net.simplace.sim.util.FWSimVariable<Integer> aLayerCount, net.simplace.sim.util.FWSimVariable<String> aDepthFieldName, String aProjectID, net.simplace.sim.io.resources.FWSimResourceCache aCache) throws net.simplace.sim.exceptions.MissingSimResourceException
      Rescales the soil layer
      Parameter:
      aThicknessOfLayers - thickness of the layers
      aLayerCount - total number of layers
      aDepthFieldName - name of the depth field
      aProjectID - id of the project
      aCache - original soil info stored
      Gibt zurück:
      the new created FWSimResourceCache
      Löst aus:
      net.simplace.sim.exceptions.MissingSimResourceException

    • updateFields

      public void updateFields(net.simplace.core.FWObservable aObservable)
      Angegeben von:
      updateFields in Klasse net.simplace.sim.io.resources.FWSimResourceTransformer
      Siehe auch:
      • FWSimResourceTransformer.updateFields(net.simplace.core.FWObservable)