VRH / VRH.Log4Pro.MaintenanceConsole

Name Last Update
..
ReadMe.md Loading commit data...

ReadMe.md

Vrh.XmlProcessing

VRH-s XML paraméter fájlok feldolgozását támogató komponens. Hasznos függvényekkel, osztályokkal és rendszeresen előforduló szerkezetek leképezésével.

Fejlesztve és tesztelve 4.5 .NET framework alatt. Teljes funkcionalitás és hatékonyság kihasználásához szükséges legalacsonyabb framework verzió: 4.5

Főbb összetevők

XmlLinqBase osztály

Egy absztrakt alaposztály, mely minden specialitás nélkül alkalmas egy XML állomány elemeinek és attribútumainak beolvasására és a típusos értékek előállítására. Az osztály a System.Xml.Linq névtér beli xml kezeléshez nyújt segédeszközöket. Az osztályban minden tulajdonság és metódus protected hatáskörű.

Felhasználási minta:

public class MyClass : XmlLinqBase { ... }
Tulajdonságok Leírás
CurrentFileName A Load metódus által legutóbb sikeresen betöltött xml fájl neve. Csak olvasható. Értéke akkor íródik felül, ha a Load minden tekintetben sikeres.
RootElement GetXElement metódusban megadott útvonal ettől az elemtől számítódik. A Load metódus beállítja (felülírja) ezt az elemet.
EnableTrim A GetValue metódusok számára engedélyezi a whitespace karakterek eltávolítását a megtalált érték elejéről és végéről. Alapértelmezett értéke: true.
Metódusok Leírás
void Load(string xmlFileName) A megadott fájlból betölti az XML struktúrát. Beállítja a CurrentFileName tulajdonságot.
XElement GetXElement(params string[] elementPath) A RootElement-ben lévő elemtől a sorban megadott elemeken keresztül elérhető elemet adja vissza.
XElement GetXElement(XElement root, params string[] elementPath) A root parméterben megadott elemtől a sorban megadott elemeken keresztül elérhető elemet adja vissza.
XElement GetXElement(string elementPath, char separator = '/') A RootElement-ben lévő elemtől az elementhPath paraméterben megadott útvonalon keresztül elérhető elemet adja vissza.
XElement GetXElement(string elementPath, bool isRequired, char separator = '/') Mint az előző, de az elem hiánya esetén és isRequired igaz értéke esetén hibát dob.
XElement GetXElement(XElement root, string elementPath, char separator = '/') A root paraméterben megadott elemtől az elementhPath paraméterben megadott útvonalon keresztül elérhető elemet adja vissza.
XElement GetXElement(XElement root, string elementPath, bool isRequired, char separator = '/') Mint az előző, de az elem hiánya esetén és isRequired igaz értéke esetén hibát dob.
T GetValue<T>(XElement xelement, T defaultValue, bool isThrowException = false, bool isRequired = false) Visszad egy element értéket a defaultValue típusának megfelelően.
T GetValue<T>(string attributeName, XElement xelement, T defaultValue, bool isThrowException = false, bool isRequired = false) Visszadja az xelement elem alatti, megnevezett attribútum értékét.
T GetValue<T>(System.Xml.Linq.XAttribute xattribute, T defaultValue, bool isThrowException = false, bool isRequired = false) Visszadja az attribútum értékét a kért típusban.
T GetValue<T>(string stringValue, T defultValue) A megadott típusra konvertál egy stringet, ha a konverzió lehetséges.
TEnum GetEnumValue<TEnum>(XAttribute xattribute, TEnum defaultValue, bool ignoreCase = true) Attribútum értéket enum típus értékké konvertálja.
TEnum GetEnumValue<TEnum>(XElement xelement, TEnum defaultValue, bool ignoreCase = true) Elem értéket enum típus értékké konvertálja.
string GetXmlPath(XAttribute xattribute) Xattribute útvonala '/Element0/Element1/Element2.Attribute' formában.
string GetXmlPath(XElement xelement) XElement útvonala 'Element0/Element1/Element2' formában.
void ThrowEx(string mess, params object[] args) System.ApplicationException dobása a megadott formázott üzenettel.

Beépített kiterjeszthető osztályok

XmlLinqBase.ElementNames osztály

Általában használatos elemnevek kiterjeszthető osztálya.

Állandó Értéke Leírás
VALUE "Value" XML tagokban lehetséges 'Value' elem eléréséhez hasznos állandó.

XmlLinqBase.Messages osztály

Általában használatos üzenetek kiterjeszthető osztálya.

Állandó Értéke Leírás
ERR_FILENOTEXIST "File does not exist! File = {0}" Nem létező fájl üzenete 1 behelyttesítéssel.
ERR_XMLROOT "The root element is missing or corrupt! File = {0}" 'Root' elem hiányzik vagy hibás XML üzenet 1 behelyettesítéssel.
ERR_MISSINGELEMENT "The '{0}' element is missing !" Az elem hiányzik üzenet 1 behelyettesítéssel.
ERR_MISSINGATTRIBUTE "The '{0}' attribute is missing in the '{1}' element!" Az attribútum hiányzik üzenet 2 behelyettesítéssel.
ERR_REQUIREDELEMENT "Value of the '{0}' element is null or empty!" Szükséges elem null vagy üres üzenet 1 behelyettesítéssel.
ERR_REQUIREDATTRIBUTE "Value of the '{0}' attribute is null or empty in the '{1}' element!" Szükséges attribútum null vagy üres üzenet 2 behelyettesítéssel.
ERR_PARSETOTYPE "The '{0}' string is not {1} type! Place='{2}'" Típus konvertálása sikertelen üzenet 3 behelyettesítéssel.

VariableDictionary

Egy System.Collections.Generic.Dictionary<string,string> alapú osztály, mely kiterjesztésre került abból a célból, hogy alkalmas legyen Név és Érték kulcspárok tárolására, és azok behelyettesítésére egy megadott cél szövegben. Az osztály létrehozható úgy , hogy tartalmazza a rendszerváltozókat. A rendszerváltozók nevei a SystemVariableNames statikus osztályban érhetőek el. Ha engedélyezve van, akkor példányosításkor egyből létrejönnek a rendszer változók is a ...BACK változók kivételével, azok ugyanis behelyettesítéskor értékelődnek ki, nem is szerepelnek a szótárban. A ...BACK változók kiértékelése csak akkor következik be behelyettesítéskor, ha a rendszerváltozók engedélyezve vannak. Behelyettesítéskor a változókat az osztály NameSeparator tulajdonság közé illesztve keresi. A NameSeparator tulajdonság alapértelmezett értéke "@@", de átállítható, ha a környezetben más használatos.

Konstruktorok

new VariableDictionary()

E konstruktor hatására egy olyan példány jön létre, mely a változónevek tekintetében betűérzékeny, nem tartalmazza a rendszerváltozókat, és az alapértelmezett ("@@") névelválasztó állítódik be.

new VariableDictionary(string lcid, string userName)

E konstruktor hatására egy olyan példány jön létre, mely a változónevek tekintetében betűérzékeny, tartalmazza a rendszerváltozókat, és az alapértelmezett ("@@") névelválasztó állítódik be. A két paraméter az LCID és USERNAME rendszerváltozók értékét állítja be. Az lcid paraméter kötelező, és érvényes nyelvi kódnak kell lennie.

new VariableDictionary(VariableDictionary.Configuration configuration)

E konstruktor esetén a configuration paraméterben található tulajdonságok határozzák meg az osztály illetve a konstruktor viselkedését.

Variable.Configuration osztály
Tulajdonság Típus Leírás
IsCaseSensitive bool Ha true, akkor a kis és nagy betűk különbözőnek számítanak a változóneveknél. Alapértelmezett érték: true.
IsIncludeSystemVariables bool Ha true, akkor a példányosításkor automatikusan létrejönnek a rendszerváltozók. Alapértelmezett érték: false.
LCID string Ha ebben az osztályban az IsIncludeSystemVariables értéke igaz, akkor ez az érték inicializálja az "LCID" rendszerváltozót. Alapértelmezett érték: null.
NameSeparator string A változónevek elválasztó jelei, mely felülírja az alapértelmezett "@@" értéket. Alapértelmezett értéke: "@@"
UserName string Ha ebben az osztályban az IsIncludeSystemVariables értéke igaz, akkor ez az érték inicializálja a "USERNAME" rendszerváltozót.

Ha a rendszer változók létrehozása engedélyezett, akkor az LCID értékének érvényes nyelvi kódnak kell lennie, egyébként hiba keletkezik.

Tulajdonságok és metódusok

A táblázatokban csak a System.Collections.Generic.Dictionary<string,string> osztályt kiterjesztő elemeket mutatjuk be.

Tulajdonságok Leírás
CurentCultureInfo Az LCID változó beállításakor kap értéket. Csak olvasható.
NameSeparator A változó neveket e separátorok közé illesztve keresi a szövegben.
IsCaseSensitive A változónevek kis/nagybetű érzékenyek, vagy sem.Csak konstruktoron keresztül állítható, egyébként olvasható.
IncludeSystemVariables Felismeri-e a rendszer változók neveit, vagy sem.Csak konstruktoron keresztül állítható, egyébként olvasható.

Ha a NameSeparator hossza 1, akkor a változót keretező kezdő és befejező karakter azonos, egyébként a

  1. karakter lesz a befejező jel. Alapértelmezett értéke "@@". Amennyiben szükség van egy alternatív elválasztó párra, akkor párosával növelhető az elválasztó párok száma. Példa: "@@##". Ilyenkor elsőként a "@" jelek közé zárt neveket keres, ha ilyet nem talál, akkor kísérletet tesz a "#" jelek közé zárt változó név keresésre. Ha a Name separator nem 1, 2 vagy páros hoszzúságú, akkor hiba keletkezik.
Metódusok Leírás
void Add(string name, string value) Egy darab név-érték pár hozzáadása a gyűjteményhez.
void Add((NameValueCollection collection, bool isOverwrite = false) Név-érték párok hozzáadása egy létező NameValueCollection-ból. Ha isOverwrite igaz, akkor az azonos kulcs értékű elemet felülírja.
void Add((Dictionary<string,string> dictionary, bool isOverwrite = false) Név-érték párok hozzáadása egy létező Dictionary<string,string>-ból. Ha isOverwrite igaz, akkor az azonos kulcs értékű elemet felülírja.
void Set(string name, string value) Megadott nevű változó értékének módosítása.
bool ContainsVariable(string name) Igaz értékkel jelzi, ha a név már szerepel a gyűjteményben.
bool IsValidName(string name) Változónév ellenőrzése. A névnek meg kell felelnie az "[a-zA-Z_]\w*" reguláris kifejezésnek.
void ResetSystemVariables() Rendszerváltozók értékének (újra)beállítása az LCID változó kivételével.
string Substitution(string text) A szövegbe behelyettesíti a gyűjteményben található változók értékét.
string Substitution(string text, string name) A szövegbe behelyettesíti a gyűjteményben a name változó értékét.
public List<string> FindVariables(string text) A függvény megnézi, hogy a megadott paraméterben léteznek-e a gyűjteményben szereplő változók. A megtalált elemek kulcsaival egy listát képez.

A rendszerváltozók

A rendszerváltozók neve egy statikus SystemVariableNames nevű osztályban érhetőek el.

Az XML fájban való hivatkozás bemutatásánál az alapértelmezett név elválasztót használtuk.

Név XML hivatkozás Leírás
LCID @LCID@ A nyelvi kódot tartalmazó rendszer változó neve.
USERNAME @USERNAME@ Egy felhasználó név, melyet példányosításkor vagy később is be lehet állítani.
TODAY @TODAY@ Mai nap rendszer változó neve.
YESTERDAY @YESTERDAY@ Tegnap rendszer változó neve.
NOW @NOW@ Most rendszerváltozó neve.
THISWEEKMONDAY @THISWEEKMONDAY@ E hét hétfő rendszer változó neve.
THISWEEKFRIDAY @THISWEEKFRIDAY@ E hét péntek rendszer változó neve.
LASTWEEKMONDAY @LASTWEEKMONDAY@ Múlt hét hétfő rendszer változó neve.
LASTWEEKFRIDAY @LASTWEEKFRIDAY@ Múlt hét péntek rendszer változó neve
THISMONTH1STDAY @THISMONTH1STDAY@ E hónap első napja rendszer változó neve.
THISMONTHLASTDAY @THISMONTHLASTDAY@ E hónap utolsó napja rendszer változó neve.
LASTMONTH1STDAY @LASTMONTH1STDAY@ Múlt hónap első napja rendszer változó neve.
LASTMONTHLASTDAY @LASTMONTHLASTDAY@ Múlt hónap utolsó napja rendszer változó neve.
MINUTESBACK @MINUTESBACK#@ Valahány(#) perccel korábbi időpont.
HOURSBACK @HOURSBACK#@ Valahány(#) órával korábbi időpont.
DAYSBACK @DAYSBACK#@ Valahány(#) nappal korábbi nap.
WEEKSBACK @WEEKSBACK#@ Valahány(#) héttel (1hét=7nap) korábbi nap.
MONTHSBACK @MONTHSBACK#@ Valahány(#) hónappal korábbi nap.

A MINUTESBACK, a HOURSBACK és a NOW formátuma "ÉÉÉÉHHNNÓÓPPMM", míg a többi dátum típusú változónak "ÉÉÉÉHHNN".

Rövidítés jelentése
É év száma 4 számjeggyel
H a hónap száma 2 számjegyen vezető zéróval
N a nap száma 2 számjegyen vezető zéróval
Ó az óra 2 számjegyen vezető zéróval
P a perc 2 számjegyen vezető zéróval
M a másodperc 2 számjegyen vezető zéróval

Osztály használatára egy minta

/// <summary>
/// Minta a VariableDictionary osztály használatára.
/// </summary>
private static void VariableDictionaryTest()
{
    try
    {
        // Az osztály példányosítása. Nyelvi kód paraméter kötelező.
        VariableDictionary vd = new VariableDictionary("hu-HU", User.Identity.Name);
        Show(vd);

        System.Threading.Thread.Sleep(1000);

        vd.ResetSystemVariables();  //rendszerváltozók újra beállítása
        Show(vd);

        vd.Add("VLTZ", "vltz értéke");  //egy változó hozzáadása
        vd["TODAY"] = "ma";             //egy változó módosítása
        vd.Remove("NOW");               //egy változó törlése
        Show(vd);

        string text = String.Concat(
            "aaaaa@YESTERDAY@bbbbbbb@TODAY@cccccccc",
            "@LASTMONTHLASTDAY@ddddddddddd\neee@DAYSBACK3@ff",
            "ff@WEEKSBACK4@gggg@MONTHSBACK10@hhhh"
        );
        string result = vd.Substitution(text);  //szövegben lévő hivatkozások behelyettesítése
        Console.WriteLine();
        Console.WriteLine($"text= {result}");
    }
    catch (Exception ex)
    {
        Console.WriteLine(ex.Message);
    }
}

private static void Show(VariableDictionary vd)
{
    Console.WriteLine();
    foreach (KeyValuePair<string,string> s in vd)
        Console.WriteLine($"Name: {s.Key,-25}Value: {s.Value}");
}

XmlCondition osztály

Az alábbi xml struktúra feldolgozását segítő osztály:

<Condition Type="equal" Test="@VAR1@" With="one">
  four
  <Conditions>
    <Condition Type="equal" Test="@VAR1@" With="xxx">xxx</Condition>
    <Condition Type="equal" Test="@VAR1@" With="one">five</Condition>
  </Conditions>
</Condition>

A 'Condition' XML elem megszerzése után egy példányosítással előáll egy XmlCondition típus.

XmlCondition condition = new XmlCondition(XML.Element("Condition"));
Tulajdonság Típus Leírás
Type string A feltétel típusa. Types enum értékek valamelyike. Alapértelmezett érték: Types.Equal.
Test string A egyik tesztelendő karakterlánc. Lehet benne XML változó. Types.Match esetén a kiértékelendő karakterléncot tartalmazza.
With string A másik tesztelendő karakterlánc. Lehet benne XML változó. Types.Match esetén a kiértékelő reguláris kifejezést tartalmazza.
Value string Igaz értékű feltétel esetén, ez lesz a releváns érték.
Conditions List<XmlCondition> XmlCondition típusú elemek listája. Ha a releváns érték más feltétel(ek)től is függ.
Metódus Leírás
bool Evaluation(VariableDictionary xmlVars) A feltétel kiértékelése. Mivel létezhetnek hivatkozások, ezért meg kell adni a változók gyűjteményét.

XmlCondition.Types enum

A feltételekben a "Type" attribútumban megadható típusok.

Név Leírás
XmlCondition.Types.Else Mindig igaz feltétel típus.
XmlCondition.Types.Equal Egyenlő. Ez az alapértelmezés.
XmlCondition.Types.NotEqual Nem egyenlő.
XmlCondition.Types.Match Regex kifejezés.

Beépített kiterjeszthető osztályok

XmlCondition.ElementNames osztály

Általában használatos elemnevek kiterjeszthető osztálya.

Állandó Értéke Leírás
CONDITIONS "Conditions" XML tagokban lehetséges 'Conditions' elem eléréséhez hasznos állandó.
CONDITION "Condition" XML tagokban lehetséges 'Condition' elem eléréséhez hasznos állandó.

XmlCondition.AttributeNames osztály

Általában használatos attribútumnevek kiterjeszthető osztálya.

Állandó Értéke Leírás
TYPE "Type" XML tagokban lehetséges 'Type' attribútum eléréséhez hasznos állandó.
TEST "Test" XML tagokban lehetséges 'Test' attribútum eléréséhez hasznos állandó.
WITH "With" XML tagokban lehetséges 'With' attribútum eléréséhez hasznos állandó.

XmlVariable osztály

Az alábbi struktúra feldolgozását segítő osztály:

<XmlVar Name="VAR3" LCID="hu-HU">
  <Conditions>
    <Condition Type="equal" Test="@VAR1@" With="one">
        four
        <Conditions>
        <Condition Type="equal" Test="@VAR1@" With="xxx">xxx</Condition>
        <Condition Type="equal" Test="@VAR1@" With="one">five</Condition>
        </Conditions>
    </Condition>
  </Conditions>
  three
</XmlVar>

VAGY

<XmlVar Name="VAR4" LCID="hu-HU">érték</XmlVar>

Xml változókat leképező osztály. Tulajdonképpen minden elem, melynek 'Name', 'LCID' attribútuma lehetséges, és van 'Value' tulajdonsága, és lehetnek benne feltétek (Conditions). Az 'XmlVar' XML elem megszerzése után egy példányosítással előáll egy XmlVariable típus.

XmlVariable variable = new XmlVariable(XML.Element("XmlVar"));
Tulajdonság Típus Leírás
Name string A változó neve. Csak olyan változó jön létre a példányosításkor, amelynek létezik a megnevezése.
LCID string A változó értékét, melyik nyelvi környezet esetén lehet felhasználni. Ha nincs vagy üres, akkor mindegyikben.
Value string A változó értéke.
Conditions List<XmlCondition> A változó végleges értékét befolyásoló feltételek listája. Az első igaz érték lesz a végleges érték.
Metódus Leírás
bool Evaluation(VariableDictionary xmlVars) A változó kiértékelése. Mivel létezhetnek hivatkozások a feltételekben, ezért meg kell adni a változók gyűjteményét.

Beépített kiterjeszthető osztályok

XmlVariable.ElementNames osztály

Általában használatos elemnevek kiterjeszthető osztálya. Az XmlLinqBase hasonló osztályát terjeszti ki.

Állandó Értéke Leírás
XMLVAR "XmlVar" XML tagokban lehetséges 'XmlVar' elem eléréséhez hasznos állandó.
CONNECTIONSTRING "ConnectionString" XML tagokban lehetséges 'ConnectionString' elem eléréséhez hasznos állandó.

XmlVariable.AttributeNames osztály

Általában használatos attribútumnevek kiterjeszthető osztálya.

Állandó Értéke Leírás
NAME "Name" XML tagokban lehetséges 'Name' attribútum eléréséhez hasznos állandó.
LCID "LCID" XML tagokban lehetséges 'LCID' attribútum eléréséhez hasznos állandó.

XmlConnection osztály

Az XmlPaser példányosításához egy kapcsolati sztring szükséges, amelyet ez az osztály ellenőriz és kifejt. Az alábbi táblázat "Tulajdonság" oszlopában zárójelben az látható, hogy az adott összetevőnek milyen néven kell szerepelnie a kapcsolati stringben.

Tulajdonság Típus Leírás
Root (root) string A gyökér XML fájl az elérési útvonalával együtt, tartalmazhat relatív útvonalat is.
ConfigurationName (config) string A konfiguráció neve, amit keresünk a gyökér XmlParser fájlban.
File (file) string Ha ez van megadva a connection stringben, akkor itt van a komponens xml paraméter fájlja.
Element (element) string Ha ez van megadva a connection stringben, akkor a komponens xml paraméter fájljában ezen elem alatt található a struktúra.
Metódus Leírás
void SetPath(string appPath) A 'Root' és 'File' tulajdonságok relatív értékének feloldása a megadott útvonallal.

Alapértelmezettől eltérő konstruktorok

Konstruktor Leírás
XmlConnection(string xmlConnectionString, bool isRequired = true) XmlConnection példányosítása egy kapcsolati sztring megadásával, melynek során a sztring ellenőrzésre és feldolgozásra kerül.
XmlConnection(string xmlConnectionString, string defaultValue, DefaultTypes defaultType = DefaultTypes.File) XmlConnection példányosítása egy kapcsolati sztring megadásával, melynek során a sztring ellenőrzésre és feldolgozásra kerül. Alapértelmezett értéket lehet megadni a "file" vagy "config" elemnek, ha azok üresek egyébként.

Nyilvános állandók

Elérésükre egy minta:

XmlConnection.CSNAME_ROOT
Állandó Értéke Leírás
CSNAME_ROOT "root" A kapcsolati sztring "root" elem megnevezésének állandója.
CSNAME_CONFIG "config" A kapcsolati sztring "config" elem megnevezésének állandója.
CSNAME_FILE "file" A kapcsolati sztring "file" elem megnevezésének állandója.
CSNAME_ELEMENT "element" A kapcsolati sztring "element" elem megnevezésének állandója.
SEPARATOR_NAMEVALUE "=" Egy elemben a név és értéket elválasztó jel.
SEPARATOR_ITEM ";" A kapcsolati sztringben az egyes elemeket elválasztó jel.

Kapcsolati sztring felépítése:

A minimum igény, hogy a 'config' vagy a 'file' tagnak szerepelnie kell. A config az erősebb, ha mindkettő szerepel. Pár minta:

  • "root=D:\SandBox\XmlParser\XmlParser.xml;config=FileManager" vagy
  • "root=D:\SandBox\XmlParser\XmlParser.xml;file=D:\aaa\bbb\FileManager.xml;element=RootAlattiElemNév"
  • Ha 'root' nem szerepel, akkor a gyökér fájl (1) elsődleges alapértelmezését az alkalmazás appconfig file-jában levő "Vrh.XmlParser:root" nevű elem tartalmazza; ha ez nem létezik, vagy értéke üres, akkor (2) a másodlagos alapértelmezés "~/App_Data/XmlParser/XmlParser.xml".
  • A felhasználó komponensek fogadhatnak üres kapcsolati stringet, ha számukra van érvényes alapértelmezett konfiguráció név. Például a FileManager meghívható kapcsolati sztring nélkül, akkor a FilManager a következő sztringet generálja: "config:FileManager", és ezzel inicializálja az XmlParser-t.

XmlParser osztály

Az 'XmlParser' XML elem feldolgozását elvégző absztrakt osztály. A VRH paraméterező XML állományainak egységes szerkezetű eleme, mely definiálja az állomány részére a változókat, és kapcsolatokat. Valamint meghatározza a paraméterezés nyelvi környezetét, ha azt nem adják meg a programban. Az XmlParser paraméterfájljainak általános felépítése és logikája a következő:

<!-- Az XmlParser gyökér paraméterfájl -->
<ParserConfig LCID="" NameSeparator="">        <!-- NameSeparator opcionális -->
  <XmlParser>                              
    <ConnectionString Name="" LCID="">...VALUE...</ConnectionString><!-- LCID opcionális -->
    <XmlVar Name="" LCID="">...VALUE...</XmlVar>
    <XmlVar Name="" LCID="">...VALUE...</XmlVar>
    <XmlVar Name="" LCID="">...VALUE...
      [<Conditions>
        <Condition Type="" Test="" With="">...VALUE...
          [<Conditions>...</Conditions>]
        </Condition>
      </Conditions>]
    </XmlVar>
  </XmlParser>
  <Configurations>
    <Configuration Name="Sample1" File="Sample1File" Element="FirstElement/SecondElement">
    <Configuration Name="Sample2" Element="Sample2Element">        <!-- File,Element valamelyik kötelező -->
    <Configuration Name="Sample3" File="Sample3File">
  </Configurations>
  <Sample2Element>
    [<XmlParser>...<XmlParser>]
    .
    .
    .
  </Sample2Element>
</ParserConfig>

Sample1File:

<Root>
  [<XmlParser>...</XmlParser>]
  <FirstElement>
    <SecondElement>
      [<XmlParser>...</XmlParser>]
      .
      .
      .
    </SecondElement>
  </FirstElement>
</Root>

Sample3File:

<Root>
  [<XmlParser>...</XmlParser>]
  .
  .
  .
</Root>

Az osztály a lenti sorrendben és helyeken elvégzi az XmlParser elemek feldolgozását:

  • Az XmlParser.xml fájl gyökerében elhelyezett XmlParser elem
  • A konfiguráció által meghatározott fájl gyökér eleme alatti XmlParser elem
  • A konfiguráció által meghatározott fájl és egy ottani elem alatti XmlParser elem Az XmlVar elemek (a továbbiakban változók) egy későbbi XmlParser-ban felülírhatóak. Másképpen fogalmazva: ha a feldolgozás során olyan változót talál, mely már egy korábbi XmlParser-ban szerepelt, akkor annak értéke felülíródik a későbben megtalált ilyen nevű változó értékével. Az XmlParser elemek feldolgozása után az előfeldolgozó a paraméterező XML állományban elvégzi a változókra való hivatkozások feloldását, azaz behelyettesíti a hivatkozások helyére a változók értékét. Utána a saját xml feldolgozó részére megtartja a tartalmat. Az XmlParser.RootElement (XmlLinqBase.RootElement) tulajdonságában már egy olyan XML struktúra van, amelyben a behelyettesítések el lettek végezve. Az XmlParser (XmlLinqBase) által szolgáltatott metódusok már mind ezen az elemen dolgoznak.

Az osztály egy absztrakt osztály, felhasználása a következő módon lehetséges:

public class MyXmlProcessor : XmlParser
{
    public MyXmlProcessor() : base(xmlConnection, appPath, lcid, otherVars)
}
  • xmlConnection Az XmlParser kapcsolati objektum. Lásd: XmlConnection osztály
  • appPath A felhasználó alkalmazásban érvényes alkalmazás mappa. (A '~' jel értéke.)
  • lcid A nyelvi környezetet meghatározó nyelvi kód. Ha üres, akkor az XmlParser.xml-ben megadott nyelv kód lesz alkalmazva. Ha ott sincs, akkor "en-US".
  • otherVars Egy szótár, mely név érték párokat tartalmaznak, melyek bekerülnek az XmlVars-ok közé.
Tulajdonság Típus Leírás
XmlVars VariableCollection Változók gyűjteménye, mely tartalmazza az összes változót az értékével együtt.
ConnectionStrings VariableCollection Kapcsolatok gyűjteménye, mely tartalmazza a struktúra összes különböző nevű kapcsolatát.
CurrentFileName string Az épp feldolgozás alatt álló Xml fájl a teljes fizikai elérési útvonalával.
Configuration ConfigurationType A megadott nevű komponens Configuration elemének értékei.

Beépített static osztályok

XmlParser.Defaults osztály

Állandó Értéke Leírás
XMLFILE @"~\App_Data\XmlParser\XmlParser.xml" Az XMLParser.xml fájl meghatározott helyének állandója.

A controllerben a következő utasítással feloldható: Server.MapPath(XmlParser.Defaults.XMLFILE);

Beépített osztályok

Ha szükséges vagy hasznos, akkor a felhasználó osztály kiterjesztheti ezeket.

XmlParser.ElementNames osztály

Általában használatos elemnevek kiterjeszthető osztálya. Az XmlLinqBase hasonló osztályát terjeszti ki.

Állandó Értéke Leírás
XMLPARSER "XmlParser" XML tagokban lehetséges 'XmlVar' elem eléréséhez hasznos állandó.
XMLVAR "XmlVar" XML tagokban lehetséges 'XmlVar' elem eléréséhez hasznos állandó.
CONNECTIONSTRING "ConnectionString" XML tagokban lehetséges 'ConnectionString' elem eléréséhez hasznos állandó.
CONFIGURATIONS "Configurations" XML tagokban lehetséges 'Configurations' elem eléréséhez hasznos állandó.
CONFIGURATION "Configuration" XML tagokban lehetséges 'Configuration' elem eléréséhez hasznos állandó.

XmlParser.AttributeNames osztály

Általában használatos attribútumnevek kiterjeszthető osztálya.

Állandó Értéke Leírás
NAME "Name" XML tagokban lehetséges 'Name' attribútum eléréséhez hasznos állandó.
LCID "LCID" XML tagokban lehetséges 'LCID' attribútum eléréséhez hasznos állandó.
NAMESEPARATOR "NameSeparator" XML tagokban lehetséges 'NameSeparator' attribútum eléréséhez hasznos állandó.
FILE "File" XML tagokban lehetséges 'File' attribútum eléréséhez hasznos állandó.
ELEMENT "Element" XML tagokban lehetséges 'Element' attribútum eléréséhez hasznos állandó.

ConnectionStringStore osztály

Kapcsolati sztringek tárolójának kezelését és abban való keresést támogató osztály az egységes használat érdekében.

Használati minta: 

// SQL esetén 
string csstring = ConnectionStringStore.GetSQL(nameOrRef);
// vagy
string csstring = ConnectionStringStore.Get(nameOrRef);

// EF DBContext-nél használható így, ha jó az alapértelmezett kapcsolat
public ApplicationDbContext() : base(ConnectionStringStore.Get()) { }

// Redis esetén
string csstring = ConnectionStringStore.GetRedis(nameOrRef);
// vagy
string csstring = ConnectionStringStore.Get(nameOrRef, ConnectionStringType.Redis);

Ha a "nameOrRef" paraméter null vagy üres, akkor a "VRH.ConnectionStringStore:[CSTYPE]_connectionString" nevű kapcsolati sztringet keresi. [CSTYPE] a keresett típus szerinti érték (jelenleg SQL v. Redis). Ha a feloldás nem jár sikerrel, akkor hiba keletkezik.

A keresés algoritmusa:

Az alkalmazás konfigurációs fájljában (App.config vagy Web.config) indul a keresés.

1. Konfigurációs fájl <connectionStrings> elem

A nevet megkísérli az <add> elemben megkeresni. Egy minta:

<connectionStrings>
    <add name="DBConnection" connectionString="Data Source=.\SQLEXPRESS;Initial Catalog=DBName;user id=sa;password=***;multipleactiveresultsets=True" providerName="System.Data.SqlClient" />
</connectionStrings>

Ha van olyan <add> bejegyzés, ahol a "name" attribútum egyezik a keresett névvel, akkor a "connectionString" attribútum értéke lesz a kapcsolati sztring.

2. Konfigurációs fájl <appSettings> elem

Ha a konfigurációs fájl <connectionStrings> elemében nem találta a nevet, akkor az <appSettings> elemben keres tovább. 

<appSettings>
    <add key="VRH.ConnectionStringStore" value="connections.xml"/>
    <add key="VRH.DBConnection" value="connections.xml/QQQ|DBConnection"/>
    <add key="VRH.XmlParser:root" value="d:\!Dev\VRH\Vrh.XmlProcessing\SandBox\XmlParser.xml"/>
</appSettings>

Ha van olyan <add> bejegyzés, ahol a "key" attribútum egyezik a keresett névvel, akkor a "value" attribútum értékét egy ConnectionStringStore referenciának tekinti. Ha nem talál ilyet, akkor a nevet tekinti egy ConnectionStringStore referenciának. A referencia megmutatja, hol található a kapcsolati sztringeket tartalmazó fájl, és azon belül az az elem, ahol meghatározott szerkezetű kapcsolati sztring leírók megtalálhatóak. A referencia által megjelölt helyen, és az <XmlParser> elem <ConnectionString> elemeiben megadott sztringek egy gyűjteményt alkotnak, melyben a megadot nevet lehet keresni, A gyűjteményben nem lehetnek egyforma nevek. Hiba akkor jelentkezik, ha a keresett név nem található, vagy a referencia hibás.

ConnectionStringStore referencia formátuma

Teljes formátum: [fájl az elérési útvonal] / [XMLPath] | [cselem név] vagy rövid formátum: [cselem név] ahol

  • [file elérési útvonal]: Az xml fájlhoz vezető relatív, vagy abszolút útvonal. Ha az első karakter '@', akkor az útvonal abszolút, egyébként az exe könyvtárára relatív.
  • [XMLPath]: A kijelölt xml fájlban a connection string store root eleméig (<connectionStrings>) vezető xml elem hierarchia. A tagok "/" jellel vannak elválasztva. Tulajdonképpen az XmlParser-ból ismerős XmlConnection.Element értéke, ezért a gyökér elem nevét nem kell megadni.
  • [cselem név]: egy connectionString elem neve. A "name" attributum értéke.

Abban az esetben, ha a ConnectionStringStore referencia „rövid” formátumú, akkor a "[file elérési útvonal] / [XMLpath]" karaktersorozatot a ConnectionStringStore az App.config file <appSettings> blokkjából a "VRH.ConnectionStringStore" nevű elemből olvassa ki. Ha ilyenkor nincs ilyen, akkor az hiba.

Javasolt módszer

A konfigurációs fájlban létre kell hozni a kapcsolati sztring gyűjteményre mutató bejegyzést "VRH.ConnectionStringStore" kulcs értékkel.

<appSettings>
    <add key = "VRH.ConnectionStringStore" value="C:\ALM\wwwroot\VRHConnections.xml/configuration"/>
</appSettings>
  • Az konfigurációs fájl <connectionStrings> és <appSettings> elemeiben egyéb hivatkozás szükségtelen.
  • A Get(), GetSQL() és GetRedis() metódusok paraméterében rövid formátumú referenciát kell megadni. Értsd: csak a kapcsolati sztring nevét.
  • Alapértelmezések használata kerülendő.

LinqXMLProcessorBase osztály

Az xml paraméterfájlok feldolgozását támogató osztály, mely eseménykezeléssel és az xml paraméterfájl változásának figyelésével is fel van vértezve. Ha nincs elérhető XmlParser gyökérfájl, ezzel akkor is megvalósítható a feldolgozás, de akkor a behelyettesítéseket a feldolgozó osztálynak kell elvégeznie. Elérhető XmlParser gyökérfájl esetén az xml paraméterfájl átesik az XmlParser előfeldolgozásán, vagyis az XMlParser változók automatikusan behelyettesítve állnak rendelkezésre a feldolgozás során.

Feldolgozó osztály számára látható tagok

Tulajdonság Típus Leírás
_AppPath string A relatív útvonalak feloldó mappája.
_throwException bool Igaz értéke esetén hibák esetén exception keletkezik. Hamis érték esetén alapértelmezett értékeket eredményez a hibák elfedésére. Alapértelmezett értéke az "appSettings" "Vrh.LinqXMLProcessor.Base:ThrowExceptions" kulcs értéke. Ha ott nincs érték, akkor false.
_xmlFileDefinition string Az xml paraméter fájl fizikai elérése kiegészítve a fájlon belüli elemre hivatkozással.
_xmlNameSpace string Az xml namespace tárolására szolgáló mező.
XmlParserRoot string XmlParser számára szükséges root fájl helyének megadása. Ha üresen hagyjuk, akkor az alapértelmezés szerinti helyen keresi az XmlParser. Ha relatív (vagyis "~" jellel kezdődik, akkor érdemes kitölteni az _AppPath tulajdonságot is.
Metódus Leírás
T GetAttribute<T>(XElement element, string attributeName, T defaultValue) Visszadja egy XElement típusban található XAttribute típus értékét az elvárt típusban.
T GetElementValue<T>(XElement element, T defaultValue) Visszadja egy XElement típus értékét az elvárt típusban.
XElement GetRootElement() Az xml paraméterfájl gyökér elemének XElement objektumát adja vissza ez a függvény.
IEnumerable<XElement> GetAllXElements(params string[] elementPath) Visszaadja a paraméterek által kijelölt útvonal alatt lévő összes, az utolsó paraméterben megnevezett TAG-et
XElement GetXElement(params string[] elementPath) Visszadja a gyökér elemtől megadott elemeken át elérhető XElement objektumot.
T GetValue<T>(string stringValue, T defultValue) A megadott típusra konvertál egy sztringet, ha a konverzió lehetséges.

A metódusok felsorolása nem teljes!!!.

A korábbi dokumentáció

Ez a leírás a komponens v1.2.1 kiadásáig bezáróan naprakész. Igényelt minimális framework verzió: 4.0 Teljes funkcionalítás és hatékonyság kihasználásához szükséges legalacsonyabb framework verzió: 4.0

Ez a komponens arra szolgál, hogy az XML-ben tárolt beállítások, paraméterek feldolgozása egységes legyen, és a következő elveket kényszerítse:

  • ##### A paraméter feldolgozás tisztán OOP-elvű legyen
  • ##### Kerüljön kiemelésre egy külön osztályba, amelynek ez a scopja. Így a megvalósítás még véletlenül se legyen összeépítve a felhasználási hely feladataival, megsértve ezzel a Single Responsibility elvet.
  • ##### A használt megoldás semmilyen módon ne legyen változás érzékeny, hibatürő legyen. (Ne serializációra épüljön.)
  • ##### Kevés implementáció függő kód írásával adjon eredményt.

Használatára ez a kód minta (a kód részlet copyzható az üjabb paraméter fájlfeldolgoztó kiindulási mintajéként):

using System.Collections.Generic;
using System.Xml.Linq;
using Vrh.LinqXMLProcessor.Base;

/// TODO: Változtasd meg a felhasználási helynek megfelelő névtérre 
namespace YourNameSpace
{
    // TODO: Töröld az instrukciós megjegyzéseket (TODO) a production-level kódból, miután elvégezted a bennük foglaltakat!

    /// <summary>
    /// TODO: Mindig nevezd át ezt az osztályt!!! 
    ///         Használd az osztályra vonatkozó elnevezési konvenciókat, beszédes neveket használj a DDD (Domain Driven Development) alapelveinek megfelelően!
    ///         Naming pattern: {YourClassName}XmlProcessor 
    ///         Mindig használd az XmlProcessor suffix-et!
    /// </summary>
    public class YourClassNameXmlConfigProcessor : LinqXMLProcessorBaseClass
    {
        /// <summary>
        /// Constructor 
        ///     TODO: Nevezd át az osztály nevére!
        /// </summary>
        /// <param name="parameterFile">XML fájl aminek a feldolgozására az osztály készül</param>
        public YourClassNameXmlConfigProcessor(string parameterFile)
        {
            _xmlFileDefinition = parameterFile;
        }

        #region Retrive all information from XML

        // TODO: Írd át vagy töröld ezeket a meglévő példa implemenmtációkat! Az alapelveket bent hagyhatod, hogy később is szem előtt legyenek!
        //  Alapelvek:
        //      - Mindig csak olvasható property-ket használj getter megvalósítással, ha az adat visszanyeréséhez nem szükséges paraméter átadása!
        //      - Csak akkor használj függvényeket, ha a paraméterek átadására van szükség az információ visszanyeréséhez!
        //      - Mindig légy típusos! Az alaposztály jelenlegi implementációja (v1.1.X) az alábbi típusokat kezeli: int, string, bool, Enumerátor (generikusan)! Ha típus bővítésre lenne szükséged, kérj fejlesztést rá (change request)! 
        //      - Bonyolultabb típusokat elemi feldolgozással építs! Soha ne használj XML alapú szérializációt, amit depcreatednek tekintünk a fejlesztési környezeteinkben!
        //      - A bonyolultabb típusok kódját ne helyezd el ebben a fájlban, hanem külső definíciókat használj!
        //      - Ismétlődő információk visszanyerésére (listák, felsorolások), generikus kollekciókat használj (Lis<T>, Dictonary<Tkey, TValue>, IEnumerable<T>, stb...) 

        /// <summary>
        /// TODO: Írd felül, vagy töröld ezt a példát!
        ///     Egyszerű boolean érték visszanyerése adott element értékéből
        /// </summary>
        public bool Property1
        {
            get
            {
                return GetExtendedBoolElementValue(GetXElement(PROPERTY1_ELEMENT_NAME), true);
            }
        }

        /// <summary>
        /// TODO: Írd felül, vagy töröld ezt a példát!
        ///     Egyszerű boolean érték visszanyerése adott element alatti atribute értékéből
        /// </summary>
        public bool Property2
        {
            get
            {
                return GetExtendedBoolAttribute(GetXElement(PROPERTY1_ELEMENT_NAME), ATTRIBUTE1_ATTRIBUTE_IN_PROPERTY1_ELEMENT, false, "1", "yes");
            }
        }

        /// <summary>
        /// TODO: Írd felül, vagy töröld ezt a példát!
        ///     Lista visszaadása ismétlődő XML elemekből.
        /// </summary>
        public List<string> AllStrings
        {
            get
            {
                List<string> returnList = new List<string>();
                foreach (var item in GetAllXElements(STRINGS_ELEMENT_NAME))
                {
                    returnList.Add(GetStringElementValue(GetXElement(STRING_ELEMENT_NAME)));    
                }
                return returnList;
            }
        }

        /// <summary>
        /// TODO: Írd felül, vagy töröld ezt a példát!
        ///     Arra példa, hogy mikor használjunk metódust, property helyett: ha az adott információ visszanyeréséhez valamilyen paramétert akarunk felhasználni.
        ///     Használjunk Get prefixet ezen metódusok nevében! Adjunk DDD leveknek megfelelő beszédes neveket!
        /// </summary>
        /// <param name="group"></param>
        /// <returns></returns>
        public List<string> GetStringsUnderGroup(string group)
        {
            List<string> returnList = new List<string>();
            foreach (var item in GetAllXElements(STRINGS_ELEMENT_NAME))
            {
                if (GetStringAttribute(item, GROUP_ATTRIBUTE_IN_STRING_ELEMENT) == group)
                {
                    returnList.Add(GetStringElementValue(GetXElement(STRING_ELEMENT_NAME)));
                }
            }
            return returnList;
        }

        #endregion

        #region Defination of namming rules in XML
        // A szabályok:
        //  - Mindig konstansokat használj, hogy az element és az attribútum neveket azon át hivatkozd! 
        //  - Az elnevezések feleljenek meg a konstansokra vonatkozó elnevetési szabályoknak!
        //  - Az Attribútumok neveiben mindig jelöld, mely elem alatt fordul elő.
        //  - Az elemekre ne használj, ilyet, mert az elnevezések a hierarchia mélyén túl összetetté (hosszúvá) válnának! Ez alól kivétel, ha nem egyértelmű az elnevezés e nélkül.
        // 

        //TODO: Töröld, vagy írd felül ezeket a példa konstansokat! 
        private const string PROPERTY1_ELEMENT_NAME = "Property1";
        private const string ATTRIBUTE1_ATTRIBUTE_IN_PROPERTY1_ELEMENT = "Attribute1";        
        private const string STRINGS_ELEMENT_NAME = "Strings";
        private const string STRING_ELEMENT_NAME = "String";
        private const string GROUP_ATTRIBUTE_IN_STRING_ELEMENT = "Group";

        #endregion
    }
}

Felhasználáskor:

  • Töröld a TODO megjegyzéseket, miután végrehajtottad őket!
  • Csak valós kódot hagyj az osztályban, a példákat töröld, vagy írd át valós elemekre!
  • A szabályokra vonatkozó instrukciókat célszerűen hagyd meg a kommentekben, hogyha bárki a jövőben bővíti a feldolgozó osztályt, akkor a szeme előtt legyenek a szabályok.
  • Mindig hazsnálj XML commenteket! (Ahogy minden production Level code-ban! Ez egy erős kóddal kapcsolkatos "DONE" feltétel nálunk!)

Hibaérzékenység bekapcsolása:

A komponens alapértelmezésben hibatűrő müködésű, ha a konfigurációs fájlban hiányoznak a keresett információk, akkor defultokat ad. Azonban bekapcsolhatjuk, hogy az adott környezetben kivételerket dobjon, mikor a konfiguráció oldalon nem talál meg valamit. Ezt vagy ugy érjük el, ha a környezet konfigurációjában (App.config, Web.config) elérhető egy Vrh.LinqXMLProcessor.Base:ThrowExceptions app settings kulcs, amelynek értéke true. Vagy a leszármazott osztályban true-ra állkítjuk a _throwException protected property értékét. Figyelem, a property értékének beállítása után nem veszi többé figyelembe a fent írt app settings kulcs értékét.

Ha hibaérzékenység nem, de például logolás szükséges, akkor ezt a ConfigProcessorEvent eseményre építve lehet felépíteni. A kompones ezen az eseméynen át minden esetben jelzéstz küld a fellépő konfigurációs hibákról, amik miatt defult értékeket használ az adott konfigurációs beállításra.

Version History:

1.29.0 (2021.08.29) Compatible changes

  • ResponseTargets enum áthelyezése a Vrh.Web.Menu projektből ide.

1.28.1 Patch (2021.07.02), nuget

1.28.0 Compatible change (2021.07.01), nuget

  • SetThrowException és SetEnable FileWatcher metódudsok publikussá tétele, hogy azokkal a konstruktorokkal is lehessen használni ezeket a funkciókat, amelyekben nincs ilyen paraméter

1.27.1 Patch (2021.05.02), nuget

  • LinqXMLProcessorBaseCommonOrInstance: ha az instance xml nem létezett, akkor exception-t dobott; javítva lett, hogy ilyenkor a common xml-t használja

1.27.0 Compatible change (2021.04.27)

  • xml connection stringben a changesensitive,generatexmlerrorevent és throwexception elemek bevezetése
  • ezeket csak a LinqXMLProcessorBase alapú feldolgozás használja a korábban is meglévő, azonos nevű paraméterekkel szabályozott funkcióiban
  • mindegyik alapértelmezése false
  • switch típusú elemek, tehát nem kell név=érték formát ölteniük, elég csak a nevet szerepeltetni, amely egyenértékű a név=true; formával
  • továbbra is megmaradt, hogy ezeket az értékeket az appsettings blokkban is meg lehet adni, az ott megadott érték és a connection string-ben megadott értékek vagy kapcsolatban vannak
  • az XmlParser root file Configuration xml elemében bevezetésre került a Switches attributum, amelyben a fenti értékeket pontosvesszővel elválasztva meg lehet adni.
  • ha egy érték az xml connectionstring-ben is szerepel, meg az általa hivatkozott konfigurációs elemben is, akkor a connectionstring-ben megadott érték lesz érvényben

1.26.1 Patch (2021.02.03)

  • UrlElement/IsRelative property setter public-ra állítva

1.26.0 Compatible change (2021.01.27)

  • Bevezetésre került az url leíróban az IsRelativ field és a UrlRoot field, valamint a GetUrlAbsolute metódus csoport. Az IsRelativ true, ha az xml elemek egy relatív url-t eredményeznek; A GetUrlAbsolut metódusokban meg lehet adni egy urlroot string paramétert, amely a rooturl-t tartalmazza és hozzáfűzésre kerl a relatív url elé. Ha az url abszolut, akkor nem fűzi hozzá; Ha a rooturl paraméter üres, akkor a UrlRoot mező tartalmát fűzi a relatív url elé.

1.25.1 Patch (2021.01.27)

1.25.0 Compatible change (2021.01.27)

  • Bevezetésre került az url leíróban az url xml elem. Ha ez megadásra kerül, akkor a GetUrl metódusok a protocol, hostname,appname,area,controller és action xml elemeket nem használják, bár az UrlElement típusba az ott megadott értékek is bekerülnek. Az url xml elem tartalmazhat input paraméter elemeket is, de ebben azt esetben az url xml elem értékét az (és/ampersand) karakterrel kell zárni, ami jelzi, hogy a megadott inputparameter xml elemek kiegészítő paramétereket tartalmaznak; ha az url xml elem értékét nem az (és/ampersand) karakter zárja, akkor a megadott inputparameter xml elemek a ?(kérdőjel) karakterrel felvezetve kerülnek az url elemhez hozzáfűzésre!

1.24.0 Compatible change (2021.01.05, nuget):

  • Több Configurations elem is lehet az XmlParser root file-ban, ezek tartalmát összefűzi egy listába a feldolgozás előtt

1.23.0 Compatible change (2020.12.08, nuget):

  • A LinqXMLProcessorBase-hez a nyelvkód megadását biztosító konstruktorok hozzáadása

1.22.0 Compatible change (2020.12.08, nuget):

  • A GetValue függvény most már képes enum értékek közvetlen visszaadására

1.21.0 Compatible change (2020.11.30, nuget):

  • @THISFILE@ rendszerváltozó hozzáadása, amelyet az xmlparser az aktuális file teljes elérési útjára cserél le

1.20.0 Compatible change (2020.11.25, nuget):

  • Az xml parser element connection string nem csak egy xml elem felsorolást, hanem egy szabályos XPath kifejezést tartalmazhat.
  • Az eddigi xml elem felsorolás a leggyakrabban alkalmazott / szeparátor karakterrel egy xpath kifejezés is egyben, így a kompatibilitás ezekkel megmarad.
  • A fejlesztés feleslegessé teszi az xmlparser connectionstring-ben az id elemet, hisz a funkció xpath kifejezéssel leírható, ennek ellenére az id is megmaradt, és használható. Példa: "file=x.xml;element=A/B/C;id=id1;" helyettesíthető ezzel: "file=x.xml;element=A/B/C[@id='id1'];"

1.19.1 Patch:

  • hiba javítása, ami miatt a /-lel kezdődő element-ek esetén hibás működést eredményezett

1.19.0 Compatible changes:

  • a kapcsolatleírók Merge-elésében levő logikai hiba kijavítása
  • a Configuration elemben nem lehet Id és Preset attributum
  • ha a connectionstring-ben a config és az element együtt szerepelnek, akkor az element-ben megadott XPath a config definícióban levő element-hez képest relatív
  • ha egy XmlConnection-t mergelek egy second connection string-gel, akkor a second-ban levő element első karakterétől függően lecseréli az XmlConnection-ben levő element értéket (első karakter = "/" esetén), vagy hozzáfűzi ahhoz; a fentiek alapján a configban megadott file és element értékek által meghatározott xml elemből a connectionstring-ben megadott kiegészítő adatokkal nem lehet kijönni!

1.18.5 Patch:

  • csomagok frissítése

1.18.4 (2020.10.26) Patch:

  • Az XmlConnection példányt nem írhatjuk felül büntetlenül, hiszen bizonyos alkalmazások meg pont arra számítanak, hogy ott az általuk ismert érték marad benne. Az XmlParser.Configuration protected tulajdonság pont arra való, hogy az XmlParser származtatott osztályaiban a feloldott értékeket el lehessen érni.
  • Bevezetésre került az XmlParser.Configuration-ben a "Root" tulajdonság, így minden XmlConnection-ban is megadható tulajdonság feloldott értéke elérhető a típusban.

1.18.3 (2020.04.30) Patch:

  • Annak a hibának a javítása, hogy a config=xxxx; típusú connectionstring-ek esetén az XmlConnection példány File és Element mezői nem kerültek kitöltésre, és ez a LinqXMLProcessingBase osztályon belül hibát okozott; a hiba javítása csak a megtapasztalt Exception elhárítására szorítkozik, de szerintem a teljes javítás igényelné, hogy az XmlConnection példány konstruktorai a connectionstring-et teljesen feloldják és ezeket a mezőket is kitöltsék!

1.18.2 (2020.03.30) Patch:

  • Apró javítás a "nuspec" és az "AddToTestNuGetPackages.ps1" fájlban.

1.18.1 (2020.03.30) Patch:

  • NameSpace használatának kivétele az XmlLinqBase osztályból.

1.18.0 (2020.03.28) Compatible changes:

  • XmlParser osztály kiegészült a publikus "RootElementName" tulajdonsággal, mely a megnyitott fájl gyökér elemének nevét tartalmazza. Egy XPath kifejezés összeállításához használható, mert ott szükséges a gyökér nevét is megadni egy elem vagy attribútum eléréséhez.
  • Most már kap értéket a publikus "CurrentXmlConnectionString" tulajdonság abban az esetben is, ha XmlConnection típussal példányosítottak.
  • Frissítés az MSTest.TestAdapter 2.1.0 változatára. (Ez csak a Test projektet érinti!)
  • Frissítés az MSTest.TestFramework 2.1.0 változatára. (Ez csak a Test projektet érinti!)
  • NuGet csomag módosítása úgy, hogy a modul ReadMe.md "Build Action" tulajdonsága "None" legyen a telepítés után. Install.ps1 hozzáadása.

1.17.0 (2020.02.14) Compatible change:

  • XmlParser osztály kiegészült a publikus CurrentXmlConnectionString-gel, ami a konstruktornak átadott xml connectionstring-et tartalmazza.

1.16.0 (2020.02.10) Compatible change:

  • Az eddig m_BaseFolder privát field átalakítása BaseFolder public attributummá.

1.15.4 (2020.02.04) Patches:

  • A ConnectionStringStore exception-ök sztenderdizálása, plusz info beillesztése a szövegekbe

1.15.4 (2020.01.31) Patches:

Ha nincs megadva az AppPath paraméter, akkor alapértelmezést használt, ami azonban bizonyos esetekben nem működött, mert a "System.Reflection.Assembly.GetEntryAssembly()" metódus null értékkel tért vissza (pl. amikor a WebALM-et hívtuk a LearALMNew-ból). Ez a kód volt:

if (string.IsNullOrEmpty(xmlparserapppath))
{
    this._AppPath = Path.GetDirectoryName(System.Reflection.Assembly.GetEntryAssembly()?.Location);
}
else 
{ 
    this._AppPath = xmlparserapppath; 
}

És ez kellett helyette (nem biztos, hogy ez a tökéletes megoldás, lehet, hogy egyes esetekben még így is problémás, ha pl. ha nem webalkalmazások esetén fordul elő a fenti null értékes hívás!!!!!!!!!)

if (string.IsNullOrEmpty(xmlparserapppath))
{
    this._AppPath = Path.GetDirectoryName(System.Reflection.Assembly.GetEntryAssembly()?.Location);
    if (this._AppPath == null) this._AppPath = HttpContext.Current.Server.MapPath("~");
}
else 
{ 
    this._AppPath = xmlparserapppath; 
}

1.15.3 (2020.01.31) Patches:

  • LinqXMLProcessorBaseCommonOrInstance osztályban a GetXElement és GetAllXElement metódusokban hiba javítása.

1.15.3 (2020.01.23) Patches:

  • LinqXMLProcessorBaseCommonOrInstance osztályban a GetXElement és GetAllXElement metódusokból a felesleges generikus kivétele

1.15.1 (2020.01.22) Patches:

  • Vissza lett téve az XmlLinqBase osztályba a GetXmlPath metódus.

1.15.0 (2020.01.20)

ConnectionStringStore:

  • Több connectionString xml elem lehet, mindegyikben több connectionString elemmel; funkciója mindössze annyi, hogy a ConnectionStringStore Xml file-ban a connection string-ek ezáltal csoportosítva írhatók be, a blokkok-ban levő connections string-ek végül is egy közös listába kerülnek, ahogy eddig is.
  • Az appconfig file-ok másolása funkció kibővült azzal, hogy meg lehet adni a másolandó file-ok nevét a ConnectionStringStore xml file appconfigFileDistribution elemében (az elem értéke vesszővel elválasztott név lista, és/vagy az appconfigFileDistribution elemen belüli File elemek sorozatában megadott nevek (a File elemek mindegyike csak egy file nevet tartalmazhat); eddig ezek a nevek be voltak drótozva, ezért ez a funkció inkább főverzió-szám emelést igényelne, de spóroljunk a számokkal...
  • A másolás csak akkor történik meg, ha az appconfigFileDistribution/Enable= attributuma true értékű.
  • A másolás csak az app domain indulása utáni első ConnectionStringStore híváskor történik meg (ez web-es hívások esetén különösen "praktikus"), kivéve, ha az appconfigFileDistribution/Force= attributum értéke is true, mert ebben az esetben mindenképpen másol, tehát akkor is, ha a file-ok már ott vannak. Azt, hogy a file-ok ott vannak-e, a file-ok összehasonlításával dönti el, majd az összehasonlítás eredményét egy appdomain változóban meg is jegyzi. v1.14.xxx: kimaradt

1.13.1 (2020.01.19)

  • hiba javítása
  • xml connectionstringet, amiben csak file, vagy file+element tagok vannak le lehet írni "@c:\F1\F2\xmlfile.xml/xmltag1/xmltag2" formában ami egyenértékű a "file=c:\F1\F2\xmlfile.xml; element=xmltag1/xmltag2;" leírással;
  • ezen leírás esetén a root elemet az appconfigból veszi, az egyéb xml parser tagok nem használhatók.

1.13.0 (2020.01.02)

  • Az XmlParser alapú xml feldolgozásba a LinqXMLProcessorBase-zel azonos funkcionalitású (de nem teljesen azonos nevű) újabb metódusok beépítése: GetRootElement, GetAllXelement, GetExtendedStringValue, GetExtendedBoolValue

1.12.0 (2019.11.28)

  • wcf uri connectionstring elemben a distributecfgfiles tag bevezetése, alapértelmezés true

1.11.0 (2019.11.20)

  • WCF osztály változtatása / Kialakításra került az a funkció, amely a központi helyen (a ConnectionStringStore-t tartalmazó könyvtárból) a futó alkalmazás aktív appconfig file-ja mellé másolja a WCFServices.config,WCFClients.config,WCFBindings.config és WCFBehaviors.config file-okat, amelyek a nevüknek megfelelő xml struktúrákat tartalmazzák. Ezeknek a file-oknak a használatához szükséges, hogy az appconfig file-ban a Service.Model elemen belül a Services, Clients, Bindings és Behaviors elemek ezekre a külső fileokra hivatkozzanak,
  • WCF osztály változtatása / public static bool EnableDistributeWCFConfigFiles property bevezetése. Alalpértelmezése true. Ennek értékével lehet szabályozni, hogy a WCF inicializáló hívások a központi WCF konfigurációs file-okat bemásolják-e a web alkalmazás web.config file-ja mellé.

1.6.0 (2019.10.30) Compatible changes:

  • VariableDictionary osztályban alapértelmezett (paraméter nélküli) konstruktor bevezetése. Az osztály betűérzékeny lesz, rendszerváltozók nélkül, az alapértelmezett "@@" név szeparátorral.
  • VariableDictionary osztályban új konstruktor bevezetése, mely a beépített Configuration osztályt várja paraméternek, mely meghatározza a betűérzékenységet, rendszerváltozók létrejöttét, a név elválasztót, és két rendszerváltozó (LCID,USERNAME) értékét.

1.5.8 (2019.10.25) Patches:

  • Lemaradt Install.ps1 script pótlása a Nuget csomagban

1.5.7 (2019.10.25) Patches:

  • A nuget csomag telepítéskor elkészíti azt a minimális konfigurációt, ami a telepítés helyén való instant működőképességhez szükséges. (Minden Nuget csomagnak ez lenne a célja a belézárt komponenst illetően: A telepítés teljes automatizálása, ami azonnali használatbavételt tesz lehetővé a telepítés helyén a komponens mélyebb ismerete (pl. konfigurálás módja) nélkül!)

1.5.6 (2019.10.01) Patches:

  • Az XmlConnection összefűzős konstruktorán kellett javítani. Az elsődleges sztringből nem vette figyelembe a Root elemet.

1.5.5 (2019.09.25) Patches:

  • A Get(string,string) metódus megszüntetésre került, mert a ConnectionStringType egy publikus enum, ami mindig elérhető.

1.5.4 (2019.09.15) Patches:

  • A relatív útvonal feloldásában talált hiba javítása.

1.5.3 (2019.09.13) Patches:

  • ConnectionStringStore kiegészült az MSMQ,EmailServer és TCPIPsocket típusokkal és az ezekhez tartozó Get függvényekkel.
  • Beépítésre került egy Get(string,string) függvény is, amely string formában fogadja az enum értékek string megfelelőit

1.5.2 (2019.09.11) Patches:

  • XmlLinqBase GetXElement metódusa újabb túlterheléseket kapott. Lásd dokumentáció.

1.5.1 (2019.09.03) Patches:

  • XmlParser inicilizálásakor fellépő hiba esetén megmutatja az aktuális kapcsolati sztringet. Az eredeti hiba az InnerException-ben.
  • XElement.Load hiba esetén a fájl nevét is meg lehet tudni. Az eredeti hiba az InnerException-ben.

1.5.0 Compatible changes:

  • EmailServer connectionstring hozzáadása
  • LinqProcessorBase osztályhoz új konstruktor, amely xmlparser connection stringet fogad el paraméternek

1.4.2 (2019.08.11) Patches:

  • XElement értékének beolvasásakor az xml escape karaktereket most már visszaalakítja.

1.4.1 (2019.08.08) Patches:

  • A ConnectionStringStore xml struktúra helyét eddig csak egy speciális string-gel lehetett kijelölni, most meg XmlParser connection stringgel IS lehet. Eddig ez volt a forma: c:\A\B\cstorefile.xml/E1/E2/E3|CSname, emellett most ez is lehet:file=c:\A\B\cstorefile.xml;element=E1/E2/E3;|CSname A CSStoreReference osztály-t egyenlőre nem szüntettem meg, hanem abba beletettem mindkét formátum kezelését. A CSStoreReference osztály előállít egy XmlConnection struktúrát, amit vagy az egyik fajta, vagy a másik fajta formátum alapján csinál meg. A formátumot meg felismeri arról, hogy van-e benne "=" jel.

1.4.0 (2019.08.01) Compatible changes:

  • "id" elem bevezetése a kapcsolati sztringben. A hivatkozott elemet "Id" attribútuma alapján keresi.
  • "preset" elem bevezetése a kapcsolati sztringben. A "Preset" nélküli és a "preset" elemmel egyező XmlVar-ok kerülnek a változók közé.
  • Új konstruktor, mely egy megadott példányhoz fűzi a megadott kapcsolati sztringet.
  • Merge() metódus elkészítése, mely a meglevő objektumhoz fűzi a megadott kapcsolati sztringet.
  • "ConnectionStrings" elem feldolgozása kikerült, a továbbiakban nincs ConnectionStrings gyűjtemény az XmlParser-ban.
  • A ConnectionStrings tulajdonság megmaradt "Obsolete" jelöléssel, a kompatibilitás miatt, de mindig null lesz.
  • Tartalmazhat "config" esetén is "file" vagy egyéb elemet a kapcsolati sztring, mely felülírja/kiegészíti a "Configuration"-ban talált értékeket.
  • A HOURSBACK és a MINUTESBACK rendszerváltozók hozzáadása.

1.3.0 (2019.06.19) Compatible changes:

  • A ConnectionsStringStore a jövőben nem ad vissza alapértelmezéseket.
  • SQL típus esetén a név nélkül meghívott Get metódusok a "VRH.ConnectionStringStore:SQL_connectionString" nevű kapcsolati sztringet keresik. Ha nem található, akkor hiba keletkezik.
  • Redis típus esetén a név nélkül meghívott Get metódusok a "VRH.ConnectionStringStore:Redis_connectionString" nevű kapcsolati sztringet keresik. Ha nem található, akkor hiba keletkezik.

1.1.1 (2019.06.14) Patches:

  • Dokumentáció frissítése.

1.1.0 (2019.06.14) Compatible changes:

  • A VRH.ConnectionStringStore névtérből a "VRHConnectionStringStore" osztály áthelyezése a Vrh.XmlProcessing névtér "ConnectionStringStore" nevű osztályba.
  • A ConnectionStringStore XML átesik az XmlParser előfeldolgozásán, ha van elérhető XmlParser gyökér fájl.
  • A Vrh.LinqXMLProcessor.Base névtérből a "LinqXMLProcessorBaseClass" osztály áthelyezése a Vrh.XmlProcessing névtér "LinqXMLProcessorBase" nevű osztályába.
  • Ha van elérehtő XmlParser gyökér fájl, akkor a LinqXMLProcessorBase átesik az XmlParser előfeldolgozásán.
  • Dokumentáció frissítése.

1.0.0 (2019.05.14) Initial version:

  • A Vrh.Web.Common.Lib 1.18.1-es változatában lévő változatból készült. A Vrh.Web.Common.Lib 2.0-ás változatában már nem fog szerepelni.
  • Ha az XmlParser connection string nem tartalmaz root elemet, akkor az alapértelmezést elsődlegesen az alkalmazás appconfig file-jában levő "VRH.XmlParser:root" nevű elemből veszi ki. Ha ilyen elem nem létezik, vagy a tartalma üres, akkor használja a programba bedrótozott "~\App_Data\XmlParser\XmlParser.xml" értéket
  • Dokumentáció frissítése.
  • ReadMe.md-ből a "csharp" jelölések cseréje "javascript"-re.