xref: /trunk/main/xml2cmp/source/x2cclass/xml_cd.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef	UDKSERVICE_XML_CD_HXX
29*cdf0e10cSrcweir #define	UDKSERVICE_XML_CD_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir #include <tools/string.hxx>
33*cdf0e10cSrcweir #include "x2cstl.hxx"
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir /**	Represents one Component description from an XML file.
38*cdf0e10cSrcweir 	DatumOf() is used for tags with only one value.
39*cdf0e10cSrcweir 	DataOf() is used, if the tag has multiple values or if
40*cdf0e10cSrcweir 	you	don't know.
41*cdf0e10cSrcweir **/
42*cdf0e10cSrcweir class ComponentDescription
43*cdf0e10cSrcweir {
44*cdf0e10cSrcweir   public:
45*cdf0e10cSrcweir 	/**	@ATTENTION
46*cdf0e10cSrcweir 		Because the enum values are used as array indices:
47*cdf0e10cSrcweir 			tag_None must be the first and have the value "0".
48*cdf0e10cSrcweir 			tag_MAX must be the last.
49*cdf0e10cSrcweir 			The enum values must not be assigned numbers.
50*cdf0e10cSrcweir 	**/
51*cdf0e10cSrcweir 	enum E_Tag
52*cdf0e10cSrcweir 	{
53*cdf0e10cSrcweir 		tag_None = 0,
54*cdf0e10cSrcweir 		tag_Name,
55*cdf0e10cSrcweir 		tag_Description,
56*cdf0e10cSrcweir 		tag_ModuleName,
57*cdf0e10cSrcweir 		tag_LoaderName,
58*cdf0e10cSrcweir 		tag_SupportedService,
59*cdf0e10cSrcweir 		tag_ProjectBuildDependency,
60*cdf0e10cSrcweir 		tag_RuntimeModuleDependency,
61*cdf0e10cSrcweir 		tag_ServiceDependency,
62*cdf0e10cSrcweir 		tag_Language,
63*cdf0e10cSrcweir 		tag_Status,
64*cdf0e10cSrcweir 		tag_Type,
65*cdf0e10cSrcweir 		tag_MAX
66*cdf0e10cSrcweir 	};
67*cdf0e10cSrcweir 
68*cdf0e10cSrcweir 	virtual				~ComponentDescription() {}
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir 	/// @return All values of this tag. An empty vector for wrong indices.
71*cdf0e10cSrcweir 	virtual const std::vector< ByteString > &
72*cdf0e10cSrcweir 						DataOf(
73*cdf0e10cSrcweir 							ComponentDescription::E_Tag
74*cdf0e10cSrcweir 													i_eTag ) const = 0;
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir 	/// @return The only or the first value of this tag. An empty string for wrong indices.
77*cdf0e10cSrcweir 	virtual ByteString 	DatumOf(
78*cdf0e10cSrcweir 							ComponentDescription::E_Tag
79*cdf0e10cSrcweir 													i_eTag ) const = 0;
80*cdf0e10cSrcweir };
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir #endif
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir 
86