AttributeText.java
/*
* Copyright (c) 2002-2021, City of Paris
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright notice
* and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice
* and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* License 1.0
*/
package fr.paris.lutece.plugins.mylutece.business.attribute;
import fr.paris.lutece.plugins.mylutece.service.MyLutecePlugin;
import fr.paris.lutece.portal.service.message.AdminMessage;
import fr.paris.lutece.portal.service.message.AdminMessageService;
import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.portal.service.plugin.PluginService;
import fr.paris.lutece.portal.web.constants.Messages;
import org.apache.commons.lang3.StringUtils;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import javax.servlet.http.HttpServletRequest;
/**
*
* AttributeText
*
*/
public class AttributeText extends AbstractAttribute
{
// CONSTANTS
private static final String EMPTY_STRING = "";
// PARAMETERS
private static final String PARAMETER_TITLE = "title";
private static final String PARAMETER_HELP_MESSAGE = "help_message";
private static final String PARAMETER_MANDATORY = "mandatory";
private static final String PARAMETER_WIDTH = "width";
private static final String PARAMETER_MAX_SIZE_ENTER = "max_size_enter";
private static final String PARAMETER_VALUE = "value";
private static final String PARAMETER_IS_SHOWN_IN_SEARCH = "is_shown_in_search";
// PROPERTY
private static final String PROPERTY_TYPE_TEXT = "mylutece.attribute.type.text";
private static final String PROPERTY_CREATE_TEXT_PAGETITLE = "mylutece.create_attribute.pageTitleAttributeText";
private static final String PROPERTY_MODIFY_TEXT_PAGETITLE = "mylutece.modify_attribute.pageTitleAttributeText";
private static final String PROPERTY_MESSAGE_NO_ARITHMETICAL_CHARACTERS = "mylutece.message.noArithmeticalCharacters";
// TEMPLATES
private static final String TEMPLATE_CREATE_ATTRIBUTE = "admin/plugins/mylutece/attribute/text/create_attribute_text.html";
private static final String TEMPLATE_MODIFY_ATTRIBUTE = "admin/plugins/mylutece/attribute/text/modify_attribute_text.html";
private static final String TEMPLATE_HTML_FORM_ATTRIBUTE = "admin/plugins/mylutece/attribute/text/html_code_form_attribute_text.html";
private static final String TEMPLATE_HTML_FORM_SEARCH_ATTRIBUTE = "admin/plugins/mylutece/attribute/text/html_code_form_search_attribute_text.html";
/**
* Constructor
*/
public AttributeText( )
{
}
/**
* Get the template create an attribute
*
* @return The URL of the template
*/
public String getTemplateCreateAttribute( )
{
return TEMPLATE_CREATE_ATTRIBUTE;
}
/**
* Get the template modify an attribute
*
* @return The URL of the template
*/
public String getTemplateModifyAttribute( )
{
return TEMPLATE_MODIFY_ATTRIBUTE;
}
/**
* Get the template html form attribute
*
* @return the template
*/
public String getTemplateHtmlFormAttribute( )
{
return TEMPLATE_HTML_FORM_ATTRIBUTE;
}
/**
* Get the template html form search attribute
*
* @return the template
*/
public String getTemplateHtmlFormSearchAttribute( )
{
return TEMPLATE_HTML_FORM_SEARCH_ATTRIBUTE;
}
/**
* Get the page title for create page
*
* @return page title
*/
public String getPropertyCreatePageTitle( )
{
return PROPERTY_CREATE_TEXT_PAGETITLE;
}
/**
* Get the page title for modify page
*
* @return page title
*/
public String getPropertyModifyPageTitle( )
{
return PROPERTY_MODIFY_TEXT_PAGETITLE;
}
/**
* Set the data of the attribute
*
* @param request
* HttpServletRequest
* @return null if there are no errors
*/
public String setAttributeData( HttpServletRequest request )
{
String strTitle = request.getParameter( PARAMETER_TITLE );
String strHelpMessage = ( request.getParameter( PARAMETER_HELP_MESSAGE ) != null ) ? request.getParameter( PARAMETER_HELP_MESSAGE ).trim( ) : null;
String strIsShownInSearch = request.getParameter( PARAMETER_IS_SHOWN_IN_SEARCH );
String strMandatory = request.getParameter( PARAMETER_MANDATORY );
String strWidth = request.getParameter( PARAMETER_WIDTH );
String strMaxSizeEnter = request.getParameter( PARAMETER_MAX_SIZE_ENTER );
String strValue = request.getParameter( PARAMETER_VALUE );
if ( StringUtils.isBlank( strTitle ) )
{
return AdminMessageService.getMessageUrl( request, Messages.MANDATORY_FIELDS, AdminMessage.TYPE_STOP );
}
if ( StringUtils.isBlank( strWidth ) )
{
return AdminMessageService.getMessageUrl( request, Messages.MANDATORY_FIELDS, AdminMessage.TYPE_STOP );
}
int nWidth;
try
{
nWidth = Integer.parseInt( strWidth );
}
catch( NumberFormatException nfe )
{
return AdminMessageService.getMessageUrl( request, PROPERTY_MESSAGE_NO_ARITHMETICAL_CHARACTERS, AdminMessage.TYPE_STOP );
}
int nMaxSizeEnter = -1;
if ( StringUtils.isNotBlank( strMaxSizeEnter ) )
{
try
{
nMaxSizeEnter = Integer.parseInt( strMaxSizeEnter );
}
catch( NumberFormatException nfe )
{
return AdminMessageService.getMessageUrl( request, PROPERTY_MESSAGE_NO_ARITHMETICAL_CHARACTERS, AdminMessage.TYPE_STOP );
}
}
setTitle( strTitle );
setHelpMessage( strHelpMessage );
setMandatory( strMandatory != null );
setShownInSearch( strIsShownInSearch != null );
if ( getListAttributeFields( ) == null )
{
List<AttributeField> listAttributeFields = new ArrayList<AttributeField>( );
AttributeField attributeField = new AttributeField( );
listAttributeFields.add( attributeField );
setListAttributeFields( listAttributeFields );
}
getListAttributeFields( ).get( 0 ).setValue( strValue );
getListAttributeFields( ).get( 0 ).setWidth( nWidth );
getListAttributeFields( ).get( 0 ).setMaxSizeEnter( nMaxSizeEnter );
return null;
}
/**
* Set attribute type
*
* @param locale
* locale
*/
public void setAttributeType( Locale locale )
{
AttributeType attributeType = new AttributeType( );
attributeType.setLocale( locale );
attributeType.setClassName( this.getClass( ).getName( ) );
attributeType.setLabelType( PROPERTY_TYPE_TEXT );
setAttributeType( attributeType );
}
/**
* Get the data of the user fields
*
* @param values
* The values of user fields
* @param nIdUser
* Id of the user
* @return user field data
*/
public List<MyLuteceUserField> getUserFieldsData( String [ ] values, int nIdUser )
{
List<MyLuteceUserField> listUserFields = new ArrayList<MyLuteceUserField>( );
MyLuteceUserField userField = new MyLuteceUserField( );
Plugin plugin = PluginService.getPlugin( MyLutecePlugin.PLUGIN_NAME );
List<AttributeField> listAttributeFields = AttributeFieldHome.selectAttributeFieldsByIdAttribute( _nIdAttribute, plugin );
String strValue;
if ( ( values == null ) || ( values [0] == null ) )
{
strValue = EMPTY_STRING;
}
else
{
strValue = values [0];
}
userField.setUserId( nIdUser );
userField.setAttribute( this );
userField.setAttributeField( listAttributeFields.get( 0 ) );
userField.setValue( strValue );
listUserFields.add( userField );
return listUserFields;
}
/**
* Get whether the attribute is anonymizable.
*
* @return True if the attribute can be anonymized, false otherwise.
*/
public boolean isAnonymizable( )
{
return true;
}
}