n2n Page Rocket 1 API

rocket\spec\extr

­Spec­Config­Source­Decorator

SpecConfigSourceDecorator
Decorates the ConfigSource of a spec configuration from a single module and provides simplified interface to read from and write to this ConfigSource. This class is used by SpecExtractionManager.

Methods summary

Modifier and Type Method
public __construct ( WritableConfigSource configSource , string moduleNamespace )
public string getModuleNamespace ( )
public WritableConfigSource getConfigSource ( )
public extract ( )
public flush ( )
public clear ( )
public CustomTypeExtraction [] getCustomTypeExtractions ( )
public setCustomTypeExtractions ( CustomTypeExtraction customTypeExtractions )
public addCustomTypeExtraction ( CustomTypeExtraction customTypeExtraction )
public EiTypeExtraction [] getEiTypeExtractions ( )
public setEiTypeExtractions ( array eiTypeExtractions )
public addEiTypeExtraction ( EiTypeExtraction eiTypeExtraction )
public getEiMaskEiTypeIds ( )
public getEiTypeExtensionExtractionsByEiTypeId ( unknown eiTypeId )
public setEiTypeExtensionExtractions ( unknown eiTypeId , array eiTypeExtensionExtractions )
public addEiTypeExtensionExtraction ( unknown eiTypeId , EiTypeExtensionExtraction eiTypeExtensionExtraction )
public getEiTypeExtensionExtractionGroups ( )
public getEiModificatorExtractionGroups ( )
public getEiModificatorsEiTypeIds ( )
public getEiModificatorExtractionsByEiTypeId ( string eiTypeId )
public setEiModificatorExtractions ( string eiTypeId , array eiModificatorExtractions )
public addEiModificatorExtraction ( string eiTypeId , EiModificatorExtraction eiModificatorExtraction )
public getLaunchPadExtractions ( )
public addLaunchPadExtraction ( LaunchPadExtraction launchPadExtraction )

Methods in detail

  • __construct

    public __construct ( WritableConfigSource configSource , string moduleNamespace )
    param
    string moduleNamespace

  • getModuleNamespace

    string public getModuleNamespace ( )
    return
    string

  • getConfigSource

    WritableConfigSource public getConfigSource ( )

  • extract

    public extract ( )
    Reads the decorated ConfigSource and uses SpecExtractor to extract all TypeExtractions, EiTypeExtensionExtractions, LaunchPadExtractions and overwrites the matching properties on this class. You can access these properties through the getter methods.

  • flush

    public flush ( )
    Uses SpecRawer to do the opposite of SpecConfigSourceDecorator::extract().

  • clear

    public clear ( )

  • getCustomTypeExtractions

    CustomTypeExtraction public getCustomTypeExtractions ( )

  • setCustomTypeExtractions

    public setCustomTypeExtractions ( CustomTypeExtraction customTypeExtractions )

  • addCustomTypeExtraction

    public addCustomTypeExtraction ( CustomTypeExtraction customTypeExtraction )

  • getEiTypeExtractions

    EiTypeExtraction public getEiTypeExtractions ( )

  • setEiTypeExtractions

    public setEiTypeExtractions ( array eiTypeExtractions )

  • addEiTypeExtraction

    public addEiTypeExtraction ( EiTypeExtraction eiTypeExtraction )

  • getEiMaskEiTypeIds

    public getEiMaskEiTypeIds ( )

  • getEiTypeExtensionExtractionsByEiTypeId

    public getEiTypeExtensionExtractionsByEiTypeId ( unknown eiTypeId )

  • setEiTypeExtensionExtractions

    public setEiTypeExtensionExtractions ( unknown eiTypeId , array eiTypeExtensionExtractions )

  • addEiTypeExtensionExtraction

    public addEiTypeExtensionExtraction ( unknown eiTypeId , EiTypeExtensionExtraction eiTypeExtensionExtraction )

  • getEiTypeExtensionExtractionGroups

    public getEiTypeExtensionExtractionGroups ( )

  • getEiModificatorExtractionGroups

    public getEiModificatorExtractionGroups ( )

  • getEiModificatorsEiTypeIds

    public getEiModificatorsEiTypeIds ( )

  • getEiModificatorExtractionsByEiTypeId

    public getEiModificatorExtractionsByEiTypeId ( string eiTypeId )

  • setEiModificatorExtractions

    public setEiModificatorExtractions ( string eiTypeId , array eiModificatorExtractions )

  • addEiModificatorExtraction

    public addEiModificatorExtraction ( string eiTypeId , EiModificatorExtraction eiModificatorExtraction )

  • getLaunchPadExtractions

    public getLaunchPadExtractions ( )

  • addLaunchPadExtraction

    public addLaunchPadExtraction ( LaunchPadExtraction launchPadExtraction )