TRODLToXML

Overview

This class is used for converting TRODLLibrary to xml format

Location

 

constructor Create (TRODLLibrary, Boolean, string)  reintroduce overload

Creates a new instance with a supplied values.

constructor Create(const aLibrary: TRODLLibrary; aFlattenUsedRODLs: Boolean; aOutputFileName: string)

Parameters:

  • aLibrary:
  • aFlattenUsedRODLs:
  • aOutputFileName:

constructor Create (TRODLLibrary, string, Boolean, string)  overload virtual    (declared in TRODLConverter)

Creates a new instance with a supplied values.

constructor Create(const aLibrary: TRODLLibrary; const aTargetEntity: string; aFlattenUsedRODLs: Boolean; aOutputFileName: string)

Parameters:

  • aLibrary:
  • aTargetEntity:
  • aFlattenUsedRODLs:
  • aOutputFileName:

constructor Create (string, Boolean, string)  reintroduce overload

Creates a new instance with a supplied values.

constructor Create(const aLibraryFile: string; aFlattenUsedRODLs: Boolean; aOutputFileName: string)

Parameters:

  • aLibraryFile:
  • aFlattenUsedRODLs:
  • aOutputFileName:

constructor Create (string, string, Boolean, string)  overload virtual    (declared in TRODLConverter)

Creates a new instance with a supplied values.

constructor Create(const aLibraryFile: string; const aTargetEntity: string; aFlattenUsedRODLs: Boolean; aOutputFileName: string)

Parameters:

  • aLibraryFile:
  • aTargetEntity:
  • aFlattenUsedRODLs:
  • aOutputFileName:

AsBytes    (declared in TRODLConverter)

Contains the result of the conversion.

property AsBytes: TBytes read

Buffer    (declared in TRODLConverter)

Contains the result of the conversion.

property Buffer: TStrings read

ContainsServiceGroup  protected    (declared in TRODLConverter)

function ContainsServiceGroup(aEntity: TRODLEntity): Boolean

Parameters:

  • aEntity:

Convert    (declared in TRODLConverter)

Calls the IntConvert function that converts the library (if aTargetEntity is not defined) or the specified service (if aTargetEntity is defined) to the specified format. If the aLibrary is not defined, it generates an "Invalid library" error message. If the aTargetEntity is not valid, it generates an "Invalid TargetEntity "%s"" error message.

procedure Convert(const aLibrary: TRODLLibrary; const aTargetEntity: string)

Parameters:

  • aLibrary: Library with the RODL file
  • aTargetEntity: Specified service in the aLibrary

ExcludePrivateServices    (declared in TRODLConverter)

property ExcludePrivateServices: Boolean read write

ExcludeServiceGroupAttribute    (declared in TRODLConverter)

property ExcludeServiceGroupAttribute: Boolean read write

FlattenUsedRODLs  protected    (declared in TRODLConverter)

property FlattenUsedRODLs: Boolean read

GetFormat  override

Returns current format

class function GetFormat: string

GetTargetFileName  virtual    (declared in TRODLConverter)

Virtual function that returns the result file name of the converted RODL file in the ancestor classes. The aLibrary and the aTargetEntity are used as parts of the result file name.

class function GetTargetFileName(const aLibrary: TRODLLibrary; const aTargetEntity: string): string

Parameters:

  • aLibrary: Part of the result file name
  • aTargetEntity: Part of the result file name

isFlatten  protected    (declared in TRODLConverter)

function isFlatten(aEntity: TRODLEntity): Boolean

Parameters:

  • aEntity:

OutputFileName  protected    (declared in TRODLConverter)

property OutputFileName: string read

ServiceGroup    (declared in TRODLConverter)

Allows to get/set Service Groups

property ServiceGroup: string read write

StyleSheet

property StyleSheet: string read write

TargetEntity    (declared in TRODLConverter)

The name of the TRODLService service that should be converted to the specified format. This property is used when you need to convert the specified service only, not all services from your RODL file.

property TargetEntity: string read

ValidateTargetEntity  protected virtual    (declared in TRODLConverter)

Finds the aTargetEntity service in the aLibrary. Returns true when the aTargetEntity service is found in the aLibrary. Otherwise returns false.

function ValidateTargetEntity(const aLibrary: TRODLLibrary; const aTargetEntity: string): Boolean

Parameters:

  • aLibrary: Library with the RODL file
  • aTargetEntity: Specified service in the aLibrary

Write (ROUTF8String, Integer)  overload    (declared in TRODLConverter)

Adds the string someText with an Identation count of spaces before the string to the Buffer.

procedure Write(const someText: ROUTF8String; Indentation: Integer)

Parameters:

  • someText: Specified string
  • Indentation: Count of spaces before someText

WriteEmptyLine    (declared in TRODLConverter)

Adds an empty line to the Buffer.

procedure WriteEmptyLine

WriteLines    (declared in TRODLConverter)

Adds the string someText to the Buffer.

procedure WriteLines(const someText: ROUTF8String)

Parameters:

  • someText: Specified string

 

AsBytes    (declared in TRODLConverter)

Contains the result of the conversion.

property AsBytes: TBytes read

Buffer    (declared in TRODLConverter)

Contains the result of the conversion.

property Buffer: TStrings read

ExcludePrivateServices    (declared in TRODLConverter)

property ExcludePrivateServices: Boolean read write

ExcludeServiceGroupAttribute    (declared in TRODLConverter)

property ExcludeServiceGroupAttribute: Boolean read write

FlattenUsedRODLs  protected    (declared in TRODLConverter)

property FlattenUsedRODLs: Boolean read

OutputFileName  protected    (declared in TRODLConverter)

property OutputFileName: string read

ServiceGroup    (declared in TRODLConverter)

Allows to get/set Service Groups

property ServiceGroup: string read write

StyleSheet

property StyleSheet: string read write

TargetEntity    (declared in TRODLConverter)

The name of the TRODLService service that should be converted to the specified format. This property is used when you need to convert the specified service only, not all services from your RODL file.

property TargetEntity: string read

 

GetFormat  override

Returns current format

class function GetFormat: string

GetTargetFileName  virtual    (declared in TRODLConverter)

Virtual function that returns the result file name of the converted RODL file in the ancestor classes. The aLibrary and the aTargetEntity are used as parts of the result file name.

class function GetTargetFileName(const aLibrary: TRODLLibrary; const aTargetEntity: string): string

Parameters:

  • aLibrary: Part of the result file name
  • aTargetEntity: Part of the result file name

 

constructor Create (TRODLLibrary, Boolean, string)  reintroduce overload

Creates a new instance with a supplied values.

constructor Create(const aLibrary: TRODLLibrary; aFlattenUsedRODLs: Boolean; aOutputFileName: string)

Parameters:

  • aLibrary:
  • aFlattenUsedRODLs:
  • aOutputFileName:

constructor Create (TRODLLibrary, string, Boolean, string)  overload virtual    (declared in TRODLConverter)

Creates a new instance with a supplied values.

constructor Create(const aLibrary: TRODLLibrary; const aTargetEntity: string; aFlattenUsedRODLs: Boolean; aOutputFileName: string)

Parameters:

  • aLibrary:
  • aTargetEntity:
  • aFlattenUsedRODLs:
  • aOutputFileName:

constructor Create (string, Boolean, string)  reintroduce overload

Creates a new instance with a supplied values.

constructor Create(const aLibraryFile: string; aFlattenUsedRODLs: Boolean; aOutputFileName: string)

Parameters:

  • aLibraryFile:
  • aFlattenUsedRODLs:
  • aOutputFileName:

constructor Create (string, string, Boolean, string)  overload virtual    (declared in TRODLConverter)

Creates a new instance with a supplied values.

constructor Create(const aLibraryFile: string; const aTargetEntity: string; aFlattenUsedRODLs: Boolean; aOutputFileName: string)

Parameters:

  • aLibraryFile:
  • aTargetEntity:
  • aFlattenUsedRODLs:
  • aOutputFileName:

ContainsServiceGroup  protected    (declared in TRODLConverter)

function ContainsServiceGroup(aEntity: TRODLEntity): Boolean

Parameters:

  • aEntity:

Convert    (declared in TRODLConverter)

Calls the IntConvert function that converts the library (if aTargetEntity is not defined) or the specified service (if aTargetEntity is defined) to the specified format. If the aLibrary is not defined, it generates an "Invalid library" error message. If the aTargetEntity is not valid, it generates an "Invalid TargetEntity "%s"" error message.

procedure Convert(const aLibrary: TRODLLibrary; const aTargetEntity: string)

Parameters:

  • aLibrary: Library with the RODL file
  • aTargetEntity: Specified service in the aLibrary

isFlatten  protected    (declared in TRODLConverter)

function isFlatten(aEntity: TRODLEntity): Boolean

Parameters:

  • aEntity:

ValidateTargetEntity  protected virtual    (declared in TRODLConverter)

Finds the aTargetEntity service in the aLibrary. Returns true when the aTargetEntity service is found in the aLibrary. Otherwise returns false.

function ValidateTargetEntity(const aLibrary: TRODLLibrary; const aTargetEntity: string): Boolean

Parameters:

  • aLibrary: Library with the RODL file
  • aTargetEntity: Specified service in the aLibrary

Write (ROUTF8String, Integer)  overload    (declared in TRODLConverter)

Adds the string someText with an Identation count of spaces before the string to the Buffer.

procedure Write(const someText: ROUTF8String; Indentation: Integer)

Parameters:

  • someText: Specified string
  • Indentation: Count of spaces before someText

WriteEmptyLine    (declared in TRODLConverter)

Adds an empty line to the Buffer.

procedure WriteEmptyLine

WriteLines    (declared in TRODLConverter)

Adds the string someText to the Buffer.

procedure WriteLines(const someText: ROUTF8String)

Parameters:

  • someText: Specified string