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.metadata;
35  
36  import fr.paris.lutece.portal.service.util.AppPropertiesService;
37  import fr.paris.lutece.util.ReferenceList;
38  
39  import java.util.StringTokenizer;
40  
41  
42  /**
43   * Metadata Service
44   */
45  public class MetadataService
46  {
47      public static final String NO_HANDLER = "none";
48      private static final String PROPERTY_HANDLERS_LIST = "document.metadata.handlersList";
49      private static final String PREFIX_HANDLER = "document.metadata.handler.";
50      private static final String SUFFIX_DESCRIPTION = ".description";
51      private static final String SUFFIX_BEAN_NAME = ".beanName";
52      private static final String NO_HANDLER_LABEL = "None";
53  
54      ////////////////////////////////////////////////////////////////////////////
55      // Metadata handling
56      /**
57       * Get the list of metadata handlers
58       * @return The list fo metadata handlers
59       */
60      public static ReferenceList getMetadataHandlersList(  )
61      {
62          ReferenceList listHandlers = new ReferenceList(  );
63  
64          listHandlers.addItem( NO_HANDLER, NO_HANDLER_LABEL );
65  
66          String strHandlersList = AppPropertiesService.getProperty( PROPERTY_HANDLERS_LIST );
67          StringTokenizer st = new StringTokenizer( strHandlersList );
68  
69          while ( st.hasMoreTokens(  ) )
70          {
71              String strHandlerKey = st.nextToken(  );
72              listHandlers.addItem( strHandlerKey, getDescription( strHandlerKey ) );
73          }
74  
75          return listHandlers;
76      }
77  
78      /**
79       * Get the description of a handler
80       * @param strHandlerKey The key of the handler
81       * @return The description of a handler
82       */
83      public static String getDescription( String strHandlerKey )
84      {
85          return AppPropertiesService.getProperty( PREFIX_HANDLER + strHandlerKey + SUFFIX_DESCRIPTION );
86      }
87  
88      /**
89       * Get the bean name of a handler
90       * @param strHandlerKey The key of the handler
91       * @return The name of the bean of a handler
92       */
93      public static String getBeanName( String strHandlerKey )
94      {
95          return AppPropertiesService.getProperty( PREFIX_HANDLER + strHandlerKey + SUFFIX_BEAN_NAME );
96      }
97  }