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.folderlisting.business;
35
36 import fr.paris.lutece.util.xml.XmlUtil;
37
38 import javax.servlet.http.HttpServletRequest;
39
40
41 /**
42 * This class represents the business object FolderListingFile
43 */
44 public class FolderListingFile
45 {
46 ///////////////////////////////////////////////////////////////////////
47 // Constants
48
49 // Xml Tags
50 private static final String TAG_FILE = "file";
51 private static final String TAG_FILE_NAME = "file-name";
52 private static final String TAG_FILE_EXTENSION = "file-extension";
53 private static final String TAG_FILE_SIZE = "file-size";
54 private static final String TAG_FILE_DATE = "file-date";
55 private static final String TAG_FILE_PATH = "file-path";
56
57 // Variables declarations
58 private String _strName;
59 private String _strExtension;
60 private String _strDate;
61 private String _strSize;
62 private String _strPath;
63
64 /**
65 * Returns the Name
66 *
67 * @return The Name
68 */
69 public String getName( )
70 {
71 return _strName;
72 }
73
74 /**
75 * Sets the Name
76 *
77 * @param strName The Name
78 */
79 public void setName( String strName )
80 {
81 _strName = strName;
82 }
83
84 /**
85 * Returns the Extension
86 *
87 * @return The Extension
88 */
89 public String getExtension( )
90 {
91 return _strExtension;
92 }
93
94 /**
95 * Sets the Extension
96 *
97 * @param strExtension The Extension
98 */
99 public void setExtension( String strExtension )
100 {
101 _strExtension = strExtension;
102 }
103
104 /**
105 * Returns the Date
106 *
107 * @return The Date
108 */
109 public String getDate( )
110 {
111 return _strDate;
112 }
113
114 /**
115 * Sets the Date
116 *
117 * @param strDate The Date
118 */
119 public void setDate( String strDate )
120 {
121 _strDate = strDate;
122 }
123
124 /**
125 * Returns the Size
126 *
127 * @return The Size
128 */
129 public String getSize( )
130 {
131 return _strSize;
132 }
133
134 /**
135 * Sets the Size
136 *
137 * @param strSize The Size
138 */
139 public void setSize( String strSize )
140 {
141 _strSize = strSize;
142 }
143
144 /**
145 * Returns the Path
146 *
147 * @return The Path
148 */
149 public String getPath( )
150 {
151 return _strPath;
152 }
153
154 /**
155 * Sets the Path
156 *
157 * @param strPath The Path
158 */
159 public void setPath( String strPath )
160 {
161 _strPath = strPath;
162 }
163
164 /**
165 * Builds the XML content of this FolderListingFile and returns it
166 * @param request The HttpServletRequest
167 * @return the Xml content of this FolderListingFile
168 */
169 public String getXml( HttpServletRequest request )
170 {
171 StringBuffer strXml = new StringBuffer( );
172 XmlUtil.beginElement( strXml, TAG_FILE );
173
174 XmlUtil.addElement( strXml, TAG_FILE_NAME, getName( ) );
175 XmlUtil.addElement( strXml, TAG_FILE_EXTENSION, getExtension( ) );
176 XmlUtil.addElement( strXml, TAG_FILE_SIZE, getSize( ) );
177 XmlUtil.addElement( strXml, TAG_FILE_DATE, getDate( ) );
178 XmlUtil.addElement( strXml, TAG_FILE_PATH, getPath( ) );
179
180 XmlUtil.endElement( strXml, TAG_FILE );
181
182 return strXml.toString( );
183 }
184 }