Difference between revisions of "Template:PackageDocumentIntroduction"
Jump to navigation
Jump to search
(Created page with "OTX documents can be stored in a file system or in a database. If stored in a file system, certain constraints on the organisation of files and folders allow...") |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[ | + | [[Core.Documents|OTX documents]] can be stored in a file system or in a database. If stored in a file system, certain constraints on the organisation of files and folders allow a simple implementation to find OTX documents easily. The [[Core.Packages|package]] name (in dotted notation) can simply be translated into a directory path or vice versa, whereas the OTX document name can be translated directly to the file name. It is an analogy to the file system organisation of packages and classes recommended the Java Language Specification. |
| Line 6: | Line 6: | ||
| '''Java''' || '''C#''' || '''OTX''' || '''File System''' | | '''Java''' || '''C#''' || '''OTX''' || '''File System''' | ||
|-{{TableRow1}} | |-{{TableRow1}} | ||
| − | | Package || Namespace || Package || Folder | + | | Package || Namespace || [[Core.Packages|Package]] || Folder |
|-{{TableRow2}} | |-{{TableRow2}} | ||
| − | | Document || Document || Document || File | + | | Document || Document || [[Core.Documents|Document]] || File |
|-{{TableRow1}} | |-{{TableRow1}} | ||
| Class || Class || document name || File content | | Class || Class || document name || File content | ||
| Line 15: | Line 15: | ||
|} | |} | ||
| − | |||
| − | {{Important|Global entities (global constants, procedures, validities, etc.) contained in the OTX document are unambiguously identified with the combination of package- and document-name, and their name. This allows for having equal global names in different OTX files and avoiding ambiguity.}} | + | {{Important|[[Core.Documents|OTX documents]] are unambiguously identified with the combination of package name and their own name. This allows for having equal document names in different [[Core.Packages|OTX packages]] and avoiding ambiguity.}} |
| + | |||
| + | {{Important|Global entities (global constants, procedures, validities, etc.) contained in the [[Core.Documents|OTX document]] are unambiguously identified with the combination of package- and document-name, and their name. This allows for having equal global names in different OTX files and avoiding ambiguity.}} | ||
{{Important|Due to the fact that the package name of an document shall not be empty, a so called Root-Package (root folder) shall be exist.}} | {{Important|Due to the fact that the package name of an document shall not be empty, a so called Root-Package (root folder) shall be exist.}} | ||
| − | {{ImageStyleCenter|OtxDocumentStorageStructure.png|600|Package/Document Structure}} | + | |
| + | {{ImageStyleCenter|OtxDocumentStorageStructure.png|600|Package/Document Structure of OTX stored in a file system ('''package name''': Bold, ''document name'': Italic)}} | ||
Latest revision as of 02:46, 17 February 2016
OTX documents can be stored in a file system or in a database. If stored in a file system, certain constraints on the organisation of files and folders allow a simple implementation to find OTX documents easily. The package name (in dotted notation) can simply be translated into a directory path or vice versa, whereas the OTX document name can be translated directly to the file name. It is an analogy to the file system organisation of packages and classes recommended the Java Language Specification.
| Java | C# | OTX | File System |
| Package | Namespace | Package | Folder |
| Document | Document | Document | File |
| Class | Class | document name | File content |
| Analogies between Java, C # and OTX | |||
|---|---|---|---|
|
Important: OTX documents are unambiguously identified with the combination of package name and their own name. This allows for having equal document names in different OTX packages and avoiding ambiguity. |
|
|
Important: Global entities (global constants, procedures, validities, etc.) contained in the OTX document are unambiguously identified with the combination of package- and document-name, and their name. This allows for having equal global names in different OTX files and avoiding ambiguity. |
|
|
Important: Due to the fact that the package name of an document shall not be empty, a so called Root-Package (root folder) shall be exist. |
|
| Package/Document Structure of OTX stored in a file system (package name: Bold, document name: Italic) |
