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.attributes;
35  
36  import fr.paris.lutece.plugins.document.business.Document;
37  import fr.paris.lutece.plugins.document.business.attributes.DocumentAttribute;
38  import fr.paris.lutece.util.xml.XmlUtil;
39  
40  import org.apache.commons.lang3.StringUtils;
41  
42  
43  /**
44   * File attribute implementation
45   */
46  public class FileManager extends DefaultManager
47  {
48      private static final String TAG_FILE_RESOURCE = "file-resource";
49      private static final String TAG_DOCUMENT_ID = "resource-document-id";
50      private static final String TAG_ATTRIBUTE_ID = "resource-attribute-id";
51      private static final String TAG_CONTENT_TYPE = "resource-content-type";
52      private static final String TAG_FILE_SIZE = "file-size";
53      private static final String TEMPLATE_CREATE_ATTRIBUTE = "admin/plugins/document/attributes/create_file.html";
54      private static final String TEMPLATE_MODIFY_ATTRIBUTE = "admin/plugins/document/attributes/modify_file.html";
55      private static final String TEMPLATE_CREATE_PARAMETERS_ATTRIBUTE = "admin/plugins/document/attributes/create_parameters_file.html";
56      private static final String TEMPLATE_MODIFY_PARAMETERS_ATTRIBUTE = "admin/plugins/document/attributes/modify_parameters_file.html";
57  
58      /**
59       * Gets the template to enter the attribute value
60       * @return The template to enter the attribute value
61       */
62      protected String getCreateTemplate(  )
63      {
64          return TEMPLATE_CREATE_ATTRIBUTE;
65      }
66  
67      /**
68       * Gets the template to modify the attribute value
69       * @return The template to modify the attribute value
70       */
71      protected String getModifyTemplate(  )
72      {
73          return TEMPLATE_MODIFY_ATTRIBUTE;
74      }
75  
76      /**
77       * Gets the template to enter the parameters of the attribute value
78       * @return The template to enter the parameters of the attribute value
79       */
80      protected String getCreateParametersTemplate(  )
81      {
82          return TEMPLATE_CREATE_PARAMETERS_ATTRIBUTE;
83      }
84  
85      /**
86       * Gets the template to modify the parameters of the attribute value
87       * @return The template to modify the parameters of the attribute value
88       */
89      protected String getModifyParametersTemplate(  )
90      {
91          return TEMPLATE_MODIFY_PARAMETERS_ATTRIBUTE;
92      }
93  
94      /**
95       * Get the XML data corresponding to the attribute to build the document XML
96       * content
97       * @param document The document
98       * @param attribute The attribute
99       * @return The XML value of the attribute
100      */
101     public String getAttributeXmlValue( Document document, DocumentAttribute attribute )
102     {
103         StringBuffer sbXml = new StringBuffer(  );
104 
105         if ( ( attribute.getBinaryValue(  ) != null ) && ( attribute.getBinaryValue(  ).length != 0 ) )
106         {
107             XmlUtil.beginElement( sbXml, TAG_FILE_RESOURCE );
108             XmlUtil.addElement( sbXml, TAG_DOCUMENT_ID, document.getId(  ) );
109             XmlUtil.addElement( sbXml, TAG_ATTRIBUTE_ID, attribute.getId(  ) );
110             XmlUtil.addElement( sbXml, TAG_CONTENT_TYPE, attribute.getValueContentType(  ) );
111             XmlUtil.endElement( sbXml, TAG_FILE_RESOURCE );
112 
113             XmlUtil.addElement( sbXml, TAG_FILE_SIZE, attribute.getBinaryValue(  ).length );
114 
115             return sbXml.toString(  );
116         }
117 
118         return StringUtils.EMPTY;
119     }
120 }