View Javadoc
1   /*
2    * Copyright (c) 2002-2020, City of Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.document.service;
35  
36  import fr.paris.lutece.plugins.document.business.DocumentType;
37  import fr.paris.lutece.plugins.document.business.DocumentTypeHome;
38  import fr.paris.lutece.util.xml.XmlUtil;
39  
40  
41  /**
42   *
43   *
44   */
45  public class DocumentTypeService
46  {
47      private static final String TAG_DOCUMENT_TYPES = "document_types";
48      private static final String TAG_DOCUMENT_TYPE = "document_type";
49      private static final String TAG_DOCUMENT_TYPE_CODE = "code_document_type";
50      private static final String TAG_DOCUMENT_TYPE_NAME = "document_type_name";
51      private static final String TAG_DOCUMENT_TYPE_DESCRIPTION = "description";
52      private static final String TAG_DOCUMENT_TYPE_THUMBNAIL_ATTRIBUTE_ID = "thumbnail_attr_id";
53      private static final String TAG_DOCUMENT_TYPE_DEFAULT_THUMBNAIL_URL = "default_thumbnail_url";
54      private static final String TAG_DOCUMENT_TYPE_METADATA_HANDLER = "metadata_handler";
55  
56      //CONSTANTS
57      private static DocumentTypeServicee/DocumentTypeService.html#DocumentTypeService">DocumentTypeService _singleton = new DocumentTypeService(  );
58  
59      /** Creates a new instance of DocumentSpacesService */
60      private DocumentTypeService(  )
61      {
62      }
63  
64      /**
65       * Returns the unique instance of the service
66       * @return the unique instance of the service
67       */
68      public static DocumentTypeService getInstance(  )
69      {
70          return _singleton;
71      }
72  
73      /**
74       * Gets document types list as an XML document
75       * @return An XML document containing document types
76       */
77      public String getXmlDocumentTypesList(  )
78      {
79          StringBuffer sbXML = new StringBuffer(  );
80          XmlUtil.beginElement( sbXML, TAG_DOCUMENT_TYPES );
81  
82          for ( DocumentType type : DocumentTypeHome.findAll(  ) )
83          {
84              findDocumentTypes( sbXML, type.getCode(  ) );
85          }
86  
87          XmlUtil.endElement( sbXML, TAG_DOCUMENT_TYPES );
88  
89          return sbXML.toString(  );
90      }
91  
92      /**
93       * Build recursively the XML document containing the arborescence of document types
94       *
95       * @param sbXML The buffer in which adding the current space of the arborescence
96       * @param strDocumentTypeCode The current type of the recursive course
97       */
98      private void findDocumentTypes( StringBuffer sbXML, String strDocumentTypeCode )
99      {
100         DocumentType type = DocumentTypeHome.findByPrimaryKey( strDocumentTypeCode );
101 
102         XmlUtil.beginElement( sbXML, TAG_DOCUMENT_TYPE );
103         XmlUtil.addElement( sbXML, TAG_DOCUMENT_TYPE_CODE, type.getCode(  ) );
104         XmlUtil.addElement( sbXML, TAG_DOCUMENT_TYPE_NAME, type.getName(  ) );
105         XmlUtil.addElement( sbXML, TAG_DOCUMENT_TYPE_DESCRIPTION, type.getDescription(  ) );
106         XmlUtil.addElement( sbXML, TAG_DOCUMENT_TYPE_THUMBNAIL_ATTRIBUTE_ID, type.getThumbnailAttributeId(  ) );
107         XmlUtil.addElement( sbXML, TAG_DOCUMENT_TYPE_DEFAULT_THUMBNAIL_URL, type.getDefaultThumbnailUrl(  ) );
108         XmlUtil.addElement( sbXML, TAG_DOCUMENT_TYPE_METADATA_HANDLER, type.getMetadataHandler(  ) );
109         XmlUtil.endElement( sbXML, TAG_DOCUMENT_TYPE );
110     }
111 }