aermicioi.aedi_property_reader.xml.xml

1 /**
2 License:
3 	Boost Software License - Version 1.0 - August 17th, 2003
4 
5 	Permission is hereby granted, free of charge, to any person or organization
6 	obtaining a copy of the software and accompanying documentation covered by
7 	this license (the "Software") to use, reproduce, display, distribute,
8 	execute, and transmit the Software, and to prepare derivative works of the
9 	Software, and to permit third-parties to whom the Software is furnished to
10 	do so, all subject to the following:
11 	
12 	The copyright notices in the Software and this entire statement, including
13 	the above license grant, this restriction and the following disclaimer,
14 	must be included in all copies of the Software, in whole or in part, and
15 	all derivative works of the Software, unless such copies or derivative
16 	works are solely in the form of machine-executable object code generated by
17 	a source language processor.
18 	
19 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 	FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
22 	SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
23 	FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
24 	ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25 	DEALINGS IN THE SOFTWARE.
26 
27 Authors:
28 	aermicioi
29 **/
30 module aermicioi.aedi_property_reader.xml.xml_container;
31 
32 import aermicioi.aedi;
33 import aermicioi.aedi_property_reader.xml.xml_factory;
34 import aermicioi.aedi_property_reader.generic_convertor_container;
35 import aermicioi.aedi.storage.locator;
36 import std.xml;
37 import std.range;
38 import std.typecons;
39 
40 /**
41 Xml document data source/locator used by converting containers.
42 **/
43 class XmlLocator : Locator!(Element) {
44     
45     private {
46         Element xml_;
47     }
48     
49     public {
50 
51 		/**
52 		Default constructor for XmlLocator
53 		**/
54 		this() {
55 			this.xml = new Document("<a></a>");
56 		}
57         
58         @property {
59 			/**
60 			Set xml
61 			
62 			Params: 
63 				xml = xml document used as source of data
64 			
65 			Returns:
66 				typeof(this)
67 			**/
68         	XmlLocator xml(Element xml) @safe nothrow {
69         		this.xml_ = xml;
70         	
71         		return this;
72         	}
73         	
74 			/**
75 			Get xml
76 			
77 			Returns:
78 				Element
79 			**/
80         	Element xml() @safe nothrow {
81         		return this.xml_;
82         	}
83         }
84         
85         /**
86 		Get a xml element that is accessable from root element.
87 		
88 		Params:
89 			path = the element id.
90 			
91 		Throws:
92 			NotFoundException in case if the element wasn't found.
93 		
94 		Returns:
95 			Element child element if it is available.
96 		**/
97         Element get(string path) {
98             foreach (element; this.xml.elements) {
99                 if (element.tag.name == path) {
100                     return element;
101                 }
102             }
103             
104             throw new NotFoundException("Could not find child xml node identified by " ~ path ~ " in root xml");
105         }
106         
107         /**
108         Check if a xml element is present in xml by key.
109         
110         Params:
111         	path = identity of element.
112         	
113     	Returns:
114     		bool true if an element by key is present in Locator.
115         **/
116         bool has(in string path) inout {
117             foreach (element; this.xml_.elements) {
118                 if (element.tag.name == path) {
119                     return true;
120                 }
121             }
122             
123             return false;
124         }
125     }
126 }
127 
128 /**
129 Generic convertor container version for xml documents.
130 **/
131 alias XmlConvertorContainer = GenericConvertorContainer!(Element, XmlConvertorFactory);