View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.modules.ckan.service;
35  
36  import fr.paris.lutece.plugins.document.business.Document;
37  import fr.paris.lutece.portal.service.util.AppLogService;
38  import fr.paris.lutece.portal.service.util.AppPropertiesService;
39  import fr.paris.lutece.util.string.StringUtil;
40  
41  import java.util.Map;
42  
43  
44  /**
45   * CkanService
46   */
47  public class CkanService
48  {
49      public static final String NOT_FOUND = "not found";
50      private static final String PROPERTY_DATASET_URL_FORMAT = "document-ckan.datasetUrlFormat";
51      private static final String PROPERTY_RESOURCE_URL_FORMAT = "document-ckan.resourceUrlFormat";
52      private Map<String, String> _mappings;
53      private Map<String, String> _defaults;
54  
55      /**
56       * Sets the mappings (injected)
57       * @param mappings The mappings map
58       */
59      public void setMappings( Map mappings )
60      {
61          _mappings = mappings;
62      }
63  
64      /**
65       * Sets defaults (injected)
66       * @param defaults The defaults map
67       */
68      public void setDefaults( Map defaults )
69      {
70          _defaults = defaults;
71      }
72  
73      /**
74       * Return the dataset URL format
75       * @return the dataset URL format
76       */
77      public String getDatasetUrlFormat(  )
78      {
79          return AppPropertiesService.getProperty( PROPERTY_DATASET_URL_FORMAT );
80      }
81  
82      /**
83       * Return the resource URL format
84       * @return the resource URL format
85       */
86      public String getResourceUrlFormat(  )
87      {
88          return AppPropertiesService.getProperty( PROPERTY_RESOURCE_URL_FORMAT );
89      }
90  
91      /**
92       * Get the mapping value for a given key
93       * @param strKey The key
94       * @return The value
95       */
96      public String getMapping( String strKey )
97      {
98          String strMapping = _mappings.get( strKey );
99  
100         if ( strMapping != null )
101         {
102             return strMapping;
103         }
104 
105         AppLogService.info( "CKAN Mapping not found for key " + strKey );
106 
107         return "";
108     }
109 
110     /**
111      * Get a default value for a given key
112      * @param strKey The Key
113      * @return The value
114      */
115     public String getDefault( String strKey )
116     {
117         String strDefault = _defaults.get( strKey );
118 
119         if ( strDefault != null )
120         {
121             return strDefault;
122         }
123 
124         AppLogService.info( "CKAN default not found for key " + strKey );
125 
126         return "";
127     }
128 
129     /**
130      * Build the name ID
131      * @param doc The document
132      * @return The ID
133      */
134     public static String getNameId( Document doc )
135     {
136         String strID = "" + doc.getId(  ) + "-" + doc.getTitle(  );
137         strID = StringUtil.replaceAccent( strID );
138 
139         return strID.replace( " ", "_" );
140     }
141 }