GISX 3 - Administratordokumentation : Formatdefinition

Die Formatdefinition erfolgen in XML. Es empfiehlt sich folgende Deklaration:

<?xml version="1.0" encoding="UTF-8"?>
<Format xmlns="http://www.geograt.de/namespaces/gisx3/dialogdefinition/1.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...	
</Format>

Die Formatdefinition wird im Unterverzeichnis "formats" abgelegt und muss die Dateiendung ".xml" besitzen. Zudem darf nur eine Formatdefinition existieren, diese muss "formatDefinition" heißen, da diese ansonsten nicht berücksichtigt wird.

Beispiel für eine Formatdefinition:

<?xml version="1.0" encoding="UTF-8"?>
<Format xmlns="http://www.geograt.de/namespaces/gisx3/dialogdefinition/1.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<formatDefinition>
		<name>testDate</name>
		<type>
			<date>
				<dateFormat>
					<date>medium</date>
				</dateFormat>
			</date>
		</type>
	</formatDefinition>
	<formatDefinition>
		<name>testCurrency</name>
		<type>
			<currency>
				<unit>EUR</unit>
				<options>
					<style>decimal</style>
				</options>
			</currency>
		</type>
	</formatDefinition>
	<formatDefinition>
		<name>testNumber</name>
		<type>
			<number>
				<format>
					<style>decimal</style>
					<maximumFractionDigits>2</maximumFractionDigits>
					<minimumFractionDigits>3</minimumFractionDigits>
					<round>round</round>
					<useGrouping>true</useGrouping>
				</format>
			</number>
		</type>
	</formatDefinition>
</Format>

Es gilt:

Jeder <formatDefinition> Block hat zum jetzigen Zeitpunkt folgende Attribute:

• <name> := Bezeichnung der formatDefinition. Diese Bezeichnung wird bei der Formatierung eines Attributs in der Themendefinition verwendet.
• <type> := Festlegen des Formatdefinitionstyps. (date | currency | number)

Je nach <type> kann man folgende Formatdefinitionen vergeben:

type = date 

<dateFormat> := festlegen des gewünschten date-formates:

• <date> := Datumsformat ohne Zeitangabe. Mögliche Werte mit Beispielen:
  • full := "Monday, November 1, 2010"
  • long := "November 1, 2010"
  • medium := Standardwert. "Nov 1, 2010"
  • short := "11/1/10"
• <datetime> := Datumsformat mit Zeitangabe. Mögliche Werte mit Beispielen:
  • full := "Monday, November 1, 2010 at 5:55:00 PM GMT-02:00"
  • long := "November 1, 2010 at 5:55:00 PM GMT-2"
  • medium := Standardwert. "Nov 1, 2010, 5:55:00 PM"
  • short := "11/1/10, 5:55 PM"
• <time> := Zeitangabe. Mögliche Werte mit Beispielen:
  • full := "5:55:00 PM GMT-02:00"
  • long := "5:55:00 PM GMT-2"
  • medium := Standardwert. "5:55:00 PM"
  • short := "5:55 PM"
• <skeleton> := Freie Datumsformatierungen nach folgendem Muster: 

type = currency

<unit> := Festlegen des dreistelligen Währungscodes. (USD|EUR|CNY|JPY|GBP|BRL)

<options> := OPTIONAL. Es kann an dieser Stelle der Stil (<style>) einer Wertangabe formatiert werden:

• symbol := Standardwert. Schreibt das Währungszeichen hinter die Währung (123 €)
• accounting := ?????
• code := Schreibt den Währungscode hinter die Währung (123 EUR)
• name := Schreibt den Wert der Währung vollständig aus (anstatt € -> Euro)

type = number

<format> := festlegen der Formatierung eines nummerischen Wertes. Es muss hier mindestens ein Wert hinterlegt werden.

• <style> := 

  • decimal := Standardwert. Anzeige des numerischen Wertes als Dezimalwert.
  • percent :=  Anzeige des numerischen Wertes in Prozent (0.0016 -> 0,2%)

• <maximumFractionDigits> := Maximale Stellen nach dem Komma.

• <minimumFractionDigits> := Mindestanzahl der Stellen nach dem Komma.

• <round> := Runden des numerischen Wertes in folgender Form:

  • round := Standardwert. Arithmetisches Runden.
  • ceil := Aufrunden des Wertes.
  • floor := Abrunden des Wertes.
  • truncate := Abschneiden des Wertes.

• <useGrouping> := 

  • true | false :=  Standardwert "true". Einstellung ob 1000er-Trennzeichen gesetzt werden sollen, oder nicht.