com.quinsoft.zeidon.domains.StringDomain Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zeidon-joe Show documentation
The newest version!
/**
    This file is part of the Zeidon Java Object Engine (Zeidon JOE).

    Zeidon JOE is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Zeidon JOE is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Zeidon JOE.  If not, see .

    Copyright 2009-2015 QuinSoft
 */

package com.quinsoft.zeidon.domains;

import java.util.Map;
import java.util.Random;

import org.apache.commons.lang3.RandomStringUtils;
import org.apache.commons.lang3.StringUtils;

import com.quinsoft.zeidon.Application;
import com.quinsoft.zeidon.AttributeInstance;
import com.quinsoft.zeidon.EntityInstance;
import com.quinsoft.zeidon.InvalidAttributeValueException;
import com.quinsoft.zeidon.Task;
import com.quinsoft.zeidon.View;
import com.quinsoft.zeidon.ZeidonException;
import com.quinsoft.zeidon.objectdefinition.AttributeDef;
import com.quinsoft.zeidon.utils.JoeUtils;

/**
 * @author DG
 *
 */
public class StringDomain extends AbstractDomain
{
    public static final String EMPTY_STRING = "";
    private static final Random RANDOM = new Random();

    private final int maxLth;

    public StringDomain(Application application, Map domainProperties, Task task )
    {
        super( application, domainProperties, task );
        String sMaxLth = (String) domainProperties.get( "MaxStringLth" );
        if ( StringUtils.isBlank( sMaxLth ) )
            maxLth = 0;
        else
            maxLth = Integer.parseInt( sMaxLth );
    }

    /**
     * Checks to see if the application treats null strings as equal
     * to empty strings.  If so, this will convert null to "".
     *
     * @param string
     * @return
     */
    public static String checkNullString( Application app, Object string )
    {
        if ( string == null )
            return app.nullStringEqualsEmptyString() ? EMPTY_STRING : null;

        if ( string.equals( EMPTY_STRING ) )
            return EMPTY_STRING;

        return string.toString();
    }

    /**
     * Checks to see if the application for this domain treats null strings as equal
     * to empty strings.  If so, this will convert "" to null.
     *
     * @param string
     * @return
     */
    public String checkNullString( Object string )
    {
        return checkNullString( getApplication(), string );
    }

    @Override
    public Object convertExternalValue(Task task, AttributeInstance attributeInstance, AttributeDef attributeDef, String contextName, Object externalValue)
    {
        if ( externalValue instanceof View )
        {
            String str = JoeUtils.serializeView( (View) externalValue );
            return str;
        }

        // If external value is an AttributeInstance then get *its* internal value.
        if ( externalValue instanceof AttributeInstance )
            externalValue = ((AttributeInstance) externalValue).getValue();

        return checkNullString( externalValue );
    }

    @Override
    public void validateInternalValue( Task task, AttributeDef attributeDef, Object internalValue ) throws InvalidAttributeValueException
    {
        // It better be a string.
        if ( ! ( internalValue instanceof String ) )
            throw new InvalidAttributeValueException( attributeDef, internalValue, "Value must be a string" );

        String string = checkNullString( internalValue );

        if ( string != null )
        {
            // If the max length is specified for the attribute, use it instead of the domain.
            if ( attributeDef.getLength() != null )
            {
                if ( string.length() > attributeDef.getLength() )
                     throw new InvalidAttributeValueException( attributeDef, internalValue,
                                                                "Max length of %d exceeded.  Length = %d",
                                                                attributeDef.getLength(), string.length() );
            }
            else
            // Use the default domain lth.
            if ( string.length() > maxLth )
                throw new InvalidAttributeValueException( attributeDef, internalValue,
                                                           "Max length of %d exceeded.  Domain length = %d",
                                                           maxLth, string.length() );
        }
    }

    @Override
    public String convertToString(Task task, AttributeDef attributeDef, Object internalValue, String contextName)
    {
        return checkNullString( internalValue );
    }

    @Override
    public Integer convertToInteger(Task task, AttributeDef attributeDef, Object internalValue, String contextName)
    {
        try
        {
            return Integer.parseInt( (String) internalValue );
        }
        catch ( Exception e )
        {
            throw ZeidonException.wrapException( e )
                    .prependAttributeDef( attributeDef )
                    .appendMessage( "Value = %s", internalValue )
                    .appendMessage( "contextName = %s", contextName );
        }
    }

    @Override
    public Double convertToDouble(Task task, AttributeDef attributeDef, Object internalValue, String contextName)
    {
        try
        {
            return Double.parseDouble( (String) internalValue );
        }
        catch ( Exception e )
        {
            throw ZeidonException.wrapException( e )
                    .prependAttributeDef( attributeDef )
                    .appendMessage( "Value = %s", internalValue )
                    .appendMessage( "contextName = %s", contextName );
        }
    }

    /**
     * StringDomain needs to override compare() because it potentially needs to convert empty strings ("") to
     * null before doing the comparison.
     */
    @Override
    public int compare(Task task, AttributeInstance attributeInstance, AttributeDef attributeDef, Object internalValue, Object externalValue)
    {
        Object value = convertExternalValue( task, attributeInstance, attributeDef, null, externalValue );
        String s1 = checkNullString( internalValue );
        String s2 = checkNullString( value );

        Integer rc = compareNull( task, attributeDef, s1, s2);
        if ( rc != null )
            return rc;

        int c = 0;
        
        if ( attributeDef.isCaseSensitive() )
           c = s1.compareTo( s2 );
        else 
           c = s1.compareToIgnoreCase(s2);
        	
        if ( c < 0 )
            return -1;
        if ( c > 0 )
            return 1;
        return 0;
    }

    @Override
    public boolean isNull( Task task, AttributeDef attributeDef, Object value )
    {
        if ( value == null )  // Null values are always null (duh).
            return true;

        if ( value instanceof String &&
             attributeDef.getEntityDef().getLodDef().getApplication().nullStringEqualsEmptyString() &&
             StringUtils.isBlank( (String) value ) )
        {
            return true;
        }

        return false;
    }
    
    @Override
    public Object addToAttribute( Task task, AttributeInstance attributeInstance, AttributeDef attributeDef,
                                  Object currentValue, Object operand )
    {
        Object value = convertExternalValue( task, attributeInstance, attributeDef, null, operand );
        String str = checkNullString( value );
        return StringUtils.join( (String) currentValue, str );
    }

    /**
     * Generate a RANDOM test value for this domain.  This is used by test code to create RANDOM
     * test data.
     *
     * @param task current task
     * @param attributeDef def of the attribute.
     * @param entityInstance if not null this is the EntityInstance that will store the test data.
     *
     * @return RANDOM test data for this domain.
     */
    @Override
    public Object generateRandomTestValue( Task task, AttributeDef attributeDef, EntityInstance entityInstance )
    {
        int lth = RANDOM.nextInt( attributeDef.getLength() );
        return RandomStringUtils.randomAlphanumeric( lth );
    }

    public int getMaxLth()
    {
        return maxLth;
    }
}