/*
 * Copyright (c) 2010 Lockheed Martin Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.eurekastreams.server.action.request.transformer;

import java.io.Serializable;

import org.eurekastreams.commons.actions.context.ActionContext;
import org.eurekastreams.server.persistence.mappers.stream.GetItemsByPointerIds;

/**
 * Request transformer to convert String params object to entity id with provided {@link GetItemsByPointerIds} mapper.
 * 
 */
public class EntityIdFromUniqueStringKeyParameter implements RequestTransformer
{

    /**
     * flag to determine if return value should be string.
     */
    private Boolean returnValueAsString = false;

    /**
     * {@link GetItemsByPointerIds}.
     */
    @SuppressWarnings("unchecked")
    GetItemsByPointerIds keyToIdMapper;

    /**
     * Constructor.
     * 
     * @param inKeyToIdMapper
     *            {@link GetItemsByPointerIds}.
     */
    public EntityIdFromUniqueStringKeyParameter(final GetItemsByPointerIds inKeyToIdMapper)
    {
        keyToIdMapper = inKeyToIdMapper;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public Serializable transform(final ActionContext inActionContext)
    {
        return returnValueAsString ? keyToIdMapper.fetchId((String) inActionContext.getParams()).toString()
                : keyToIdMapper.fetchId((String) inActionContext.getParams());
    }

    /**
     * @param inReturnValueAsString
     *            the returnValueAsString to set
     */
    public void setReturnValueAsString(final Boolean inReturnValueAsString)
    {
        returnValueAsString = inReturnValueAsString;
    }

}