KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > loader > CmsXmlPageLoader


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/loader/CmsXmlPageLoader.java,v $
3  * Date : $Date: 2006/03/27 14:52:37 $
4  * Version: $Revision: 1.52 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.loader;
33
34 import org.opencms.file.CmsObject;
35 import org.opencms.file.CmsPropertyDefinition;
36 import org.opencms.file.CmsResource;
37 import org.opencms.main.CmsException;
38 import org.opencms.xml.I_CmsXmlDocument;
39 import org.opencms.xml.page.CmsXmlPageFactory;
40
41 import javax.servlet.ServletRequest JavaDoc;
42
43 /**
44  * OpenCms loader for resources of type <code>{@link org.opencms.file.types.CmsResourceTypeXmlPage}</code>.<p>
45  *
46  * @author Alexander Kandzior
47  * @author Carsten Weinholz
48  *
49  * @version $Revision: 1.52 $
50  *
51  * @since 6.0.0
52  */
53 public class CmsXmlPageLoader extends A_CmsXmlDocumentLoader {
54
55     /** The id of this loader. */
56     public static final int RESOURCE_LOADER_ID = 9;
57
58     /**
59      * @see org.opencms.loader.I_CmsResourceLoader#getLoaderId()
60      */
61     public int getLoaderId() {
62
63         return RESOURCE_LOADER_ID;
64     }
65
66     /**
67      * Returns a String describing this resource loader, which is (localized to the system default locale)
68      * <code>"The OpenCms default resource loader for xml pages"</code>.<p>
69      *
70      * @return a describing String for the ResourceLoader
71      */
72     public String JavaDoc getResourceLoaderInfo() {
73
74         return Messages.get().getBundle().key(Messages.GUI_LOADER_XMLPAGE_DEFAULT_DESC_0);
75     }
76
77     /**
78      * @see org.opencms.loader.A_CmsXmlDocumentLoader#unmarshalXmlDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.ServletRequest)
79      */
80     protected I_CmsXmlDocument unmarshalXmlDocument(CmsObject cms, CmsResource resource, ServletRequest JavaDoc req)
81     throws CmsException {
82
83         return CmsXmlPageFactory.unmarshal(cms, resource, req);
84     }
85
86     /**
87      * @see org.opencms.loader.A_CmsXmlDocumentLoader#getTemplatePropertyDefinition()
88      */
89     protected String JavaDoc getTemplatePropertyDefinition() {
90
91         return CmsPropertyDefinition.PROPERTY_TEMPLATE;
92     }
93 }
Popular Tags