/*****************************************************************
 *   Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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.apache.cayenne.reflect;

import java.util.List;

import org.apache.cayenne.ValueHolder;
import org.apache.cayenne.util.IndexPropertyList;

/**
 * A CollectionProperty that uses IndexPropertyList.
 * 
 * @since 1.2
 * @author Andrus Adamchik
 * @deprecated since 3.0 (no substitute exists in Cayenne)
 */
public class IndexedListProperty extends ListProperty {

    protected String indexPropertyName;

    public IndexedListProperty(ClassDescriptor owner, ClassDescriptor targetDescriptor,
            Accessor accessor, String reverseName, String indexPropertyName) {

        super(owner, targetDescriptor, accessor, reverseName);
        this.indexPropertyName = indexPropertyName;
    }

    /**
     * Creates a List indexed on a specified property.
     */
    protected ValueHolder createCollectionValueHolder(Object object)
            throws PropertyException {
        List unordered = (List) super.createCollectionValueHolder(object);
        return new IndexPropertyList(indexPropertyName, unordered, true);
    }
}
