ome-common 5.2.0-m2

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

EntityResolver.h
1 /*
2 * #%L
3 * OME-XERCES C++ library for working with Xerces C++.
4 * %%
5 * Copyright © 2006 - 2015 Open Microscopy Environment:
6 * - Massachusetts Institute of Technology
7 * - National Institutes of Health
8 * - University of Dundee
9 * - Board of Regents of the University of Wisconsin-Madison
10 * - Glencoe Software, Inc.
11 * %%
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are
34 * those of the authors and should not be interpreted as representing official
35 * policies, either expressed or implied, of any organization.
36 * #L%
37 */
38
39 #ifndef OME_COMMON_XML_ENTITYRESOLVER_H
40 #define OME_COMMON_XML_ENTITYRESOLVER_H
41
42 #include <map>
43 #include <string>
44
45 #include <ome/common/filesystem.h>
46 #include <ome/common/log.h>
47
48 #include <ome/compat/memory.h>
49
50 #include <xercesc/util/XMLEntityResolver.hpp>
51
52 namespace ome
53 {
54 namespace common
55 {
56 namespace xml
57 {
58
66 class EntityResolver : public xercesc::XMLEntityResolver
67 {
68 public:
70 EntityResolver();
71
73 ~EntityResolver();
74
82 xercesc::InputSource *
83 resolveEntity(xercesc::XMLResourceIdentifier* resource);
84
91 void
92 registerEntity(const std::string& id,
93 const boost::filesystem::path& file);
94
100 void
101 registerCatalog(const boost::filesystem::path& file);
102
103 private:
105 typedef std::map<std::string, boost::filesystem::path> entity_path_map_type;
107 typedef std::map<std::string, std::string> entity_data_map_type;
108
118 xercesc::InputSource *
119 getSource(const std::string& resource);
120
121 private:
123 ome::common::Logger logger;
125 entity_path_map_type entity_path_map;
127 entity_data_map_type entity_data_map;
128 };
129
130 }
131 }
132 }
133
134 #endif // OME_COMMON_XML_ENTITYRESOLVER_H
135
136 /*
137 * Local Variables:
138 * mode:C++
139 * End:
140 */
141
ome::common::xml::EntityResolver::registerEntity
void registerEntity(const std::string &id, const boost::filesystem::path &file)
Register a file with the entity resolver.
Definition: EntityResolver.cpp:175
ome::common::Logger
logging::sources::severity_logger_mt< logging::trivial::severity_level > Logger
Message logger.
Definition: log.h:98
ome::common::xml::EntityResolver::entity_data_map
entity_data_map_type entity_data_map
Map of system IDs to cached XML data.
Definition: EntityResolver.h:127
ome::common::xml::EntityResolver::entity_data_map_type
std::map< std::string, std::string > entity_data_map_type
Mapping from system ID to XML data.
Definition: EntityResolver.h:107
memory.h
Memory type substitution.
ome::common::xml::EntityResolver::entity_path_map_type
std::map< std::string, boost::filesystem::path > entity_path_map_type
Mapping from system ID to filesystem path.
Definition: EntityResolver.h:105
ome::common::xml::EntityResolver::resolveEntity
xercesc::InputSource * resolveEntity(xercesc::XMLResourceIdentifier *resource)
Resolve an entity.
Definition: EntityResolver.cpp:81
ome::common::xml::EntityResolver
Xerces entity resolver.
Definition: EntityResolver.h:66
ome::common::xml::EntityResolver::EntityResolver
EntityResolver()
Constructor.
Definition: EntityResolver.cpp:68
ome::common::xml::EntityResolver::getSource
xercesc::InputSource * getSource(const std::string &resource)
Get input source from file.
Definition: EntityResolver.cpp:109
filesystem.h
Boost.Filesystem compatibility.
ome
Definition: boolean.h:48
ome::common::xml::EntityResolver::registerCatalog
void registerCatalog(const boost::filesystem::path &file)
Register a catalog with the entity resolver.
Definition: EntityResolver.cpp:198
ome::common::xml::EntityResolver::entity_path_map
entity_path_map_type entity_path_map
Map of registered system IDs to filesystem paths.
Definition: EntityResolver.h:125
ome::common::xml::EntityResolver::logger
ome::common::Logger logger
Message logger.
Definition: EntityResolver.h:123
log.h
Boost.Log compatibility.
ome::common::xml::EntityResolver::~EntityResolver
~EntityResolver()
Destructor.
Definition: EntityResolver.cpp:76