dbtools/sdbcx/OContainer.java

/**************************************************************
 *
 * 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.openoffice.comp.sdbc.dbtools.sdbcx;

import java.util.ArrayList;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.TreeMap;

import org.apache.openoffice.comp.sdbc.dbtools.comphelper.CompHelper;
import org.apache.openoffice.comp.sdbc.dbtools.comphelper.OEnumerationByIndex;
import org.apache.openoffice.comp.sdbc.dbtools.util.PropertyIds;
import org.apache.openoffice.comp.sdbc.dbtools.util.Resources;
import org.apache.openoffice.comp.sdbc.dbtools.util.SharedResources;
import org.apache.openoffice.comp.sdbc.dbtools.util.StandardSQLState;

import com.sun.star.beans.UnknownPropertyException;
import com.sun.star.beans.XPropertySet;
import com.sun.star.container.ContainerEvent;
import com.sun.star.container.ElementExistException;
import com.sun.star.container.NoSuchElementException;
import com.sun.star.container.XContainer;
import com.sun.star.container.XContainerListener;
import com.sun.star.container.XEnumeration;
import com.sun.star.container.XEnumerationAccess;
import com.sun.star.container.XIndexAccess;
import com.sun.star.container.XNameAccess;
import com.sun.star.lang.EventObject;
import com.sun.star.lang.IllegalArgumentException;
import com.sun.star.lang.IndexOutOfBoundsException;
import com.sun.star.lang.WrappedTargetException;
import com.sun.star.lang.XServiceInfo;
import com.sun.star.lib.uno.helper.InterfaceContainer;
import com.sun.star.lib.uno.helper.WeakBase;
import com.sun.star.sdbc.SQLException;
import com.sun.star.sdbc.XColumnLocate;
import com.sun.star.sdbcx.XAppend;
import com.sun.star.sdbcx.XDataDescriptorFactory;
import com.sun.star.sdbcx.XDrop;
import com.sun.star.uno.AnyConverter;
import com.sun.star.uno.Type;
import com.sun.star.util.XRefreshListener;
import com.sun.star.util.XRefreshable;

/**
 * Base class for a lazy-loaded collection of database objects.
 */
public abstract class OContainer extends WeakBase implements
        XNameAccess, XIndexAccess, XEnumerationAccess,
        XContainer, XColumnLocate, XRefreshable, XDataDescriptorFactory,
        XAppend, XDrop, XServiceInfo {

    private static final String[] services = new String[] {
            "com.sun.star.sdbcx.Container"
    };

    protected final Object lock;
    private final boolean isCaseSensitive;
    private TreeMap<String,XPropertySet> entriesByName;
    private ArrayList<String> namesByIndex;
    private InterfaceContainer containerListeners = new InterfaceContainer();
    private InterfaceContainer refreshListeners = new InterfaceContainer();

    private Comparator<String> caseSensitiveComparator = new Comparator<String>() {
        @Override
        public int compare(String x, String y) {
            if (isCaseSensitive) {
                return x.compareTo(y);
            } else {
                return x.compareToIgnoreCase(y);
            }
        }
    };

    public OContainer(Object lock, boolean isCaseSensitive) {
        this.lock = lock;
        this.isCaseSensitive = isCaseSensitive;
        this.entriesByName = new TreeMap<>(caseSensitiveComparator);
        this.namesByIndex = new ArrayList<>();
    }

    public OContainer(Object lock, boolean isCaseSensitive, List<String> names) throws ElementExistException {
        this(lock, isCaseSensitive);
        for (String name : names) {
            if (entriesByName.containsKey(name)) {
                throw new ElementExistException(name, this);
            }
            entriesByName.put(name, null);
            namesByIndex.add(name);
        }
    }

    public void refill(List<String> names) {
        // We only add new elements, as per the C++ implementation.
        for (String name : names) {
            if (!entriesByName.containsKey(name)) {
                entriesByName.put(name, null);
                namesByIndex.add(name);
            }
        }
    }

    // Would be from XComponent ;)

    public void dispose() {
        EventObject event = new EventObject(this);
        containerListeners.disposeAndClear(event);
        refreshListeners.disposeAndClear(event);

        synchronized (lock) {
            for (XPropertySet value : entriesByName.values()) {
                CompHelper.disposeComponent(value);
            }
            entriesByName.clear();
            namesByIndex.clear();
        }
    }

    // XServiceInfo

    public String getImplementationName() {
        return getClass().getName();
    }

    @Override
    public String[] getSupportedServiceNames() {
        return services.clone();
    }

    @Override
    public boolean supportsService(String serviceName) {
        for (String service : getSupportedServiceNames()) {
            if (service.equals(serviceName)) {
                return true;
            }
        }
        return false;
    }

    // XIndexAccess

    @Override
    public Object getByIndex(int index) throws IndexOutOfBoundsException, WrappedTargetException {
        synchronized (lock) {
            if (index < 0 || index >= namesByIndex.size()) {
                throw new IndexOutOfBoundsException(Integer.toString(index), this);
            }
            return getObject(index);
        }
    }

    @Override
    public int getCount() {
        synchronized (lock) {
            return namesByIndex.size();
        }
    }

    // XNameAccess

    @Override
    public boolean hasByName(String name) {
        synchronized (lock) {
            return entriesByName.containsKey(name);
        }
    }

    @Override
    public Object getByName(String name) throws NoSuchElementException, WrappedTargetException {
        synchronized (lock) {
            if (!entriesByName.containsKey(name)) {
                String error = SharedResources.getInstance().getResourceStringWithSubstitution(
                        Resources.STR_NO_ELEMENT_NAME, "$name$", name);
                throw new NoSuchElementException(error, this);
            }
            return getObject(indexOf(name));
        }
    }

    @Override
    public String[] getElementNames() {
        synchronized (lock) {
            String[] names = new String[namesByIndex.size()];
            return namesByIndex.toArray(names);
        }
    }

    // XRefreshable

    @Override
    public void refresh() {
        Iterator<?> iterator;
        synchronized (lock) {
            for (XPropertySet value : entriesByName.values()) {
                CompHelper.disposeComponent(value);
            }
            entriesByName.clear();
            namesByIndex.clear();

            impl_refresh();

            iterator = refreshListeners.iterator();
        }
        if (iterator == null) {
            // early disposal
            return;
        }
        EventObject event = new EventObject(this);
        while (iterator.hasNext()) {
            XRefreshListener listener = (XRefreshListener) iterator.next();
            listener.refreshed(event);
        }
    }

    @Override
    public void addRefreshListener(XRefreshListener listener) {
        synchronized (lock) {
            refreshListeners.add(listener);
        }
    }

    @Override
    public void removeRefreshListener(XRefreshListener listener) {
        synchronized (lock) {
            refreshListeners.remove(listener);
        }
    }

    // XDataDescriptorFactory

    @Override
    public XPropertySet createDataDescriptor() {
        synchronized (lock) {
            return createDescriptor();
        }
    }

    // XAppend

    @Override
    public void appendByDescriptor(XPropertySet descriptor) throws SQLException, ElementExistException {
        Iterator<?> iterator;
        ContainerEvent event;
        synchronized (lock) {
            String name = getNameForObject(descriptor);

            if (entriesByName.containsKey(name)) {
                throw new ElementExistException(name, this);
            }

            XPropertySet newlyCreated = appendObject(name, descriptor);
            if (newlyCreated == null) {
                throw new RuntimeException();
            }

            name = getNameForObject(newlyCreated);
            XPropertySet value = entriesByName.get(name);
            if (value == null) { // this may happen when the derived class included it itself
                entriesByName.put(name, newlyCreated);
                namesByIndex.add(name);
            }

            // notify our container listeners
            event = new ContainerEvent(this, name, newlyCreated, null);
            iterator = containerListeners.iterator();
        }
        while (iterator.hasNext()) {
            XContainerListener listener = (XContainerListener) iterator.next();
            listener.elementInserted(event);
        }

    }

    public void insertElement(String name, XPropertySet element) {
        synchronized (lock) {
            if (!entriesByName.containsKey(name)) {
                entriesByName.put(name, element);
                namesByIndex.add(name);
            }
        }
    }

    // XDrop

    @Override
    public void dropByName(String name) throws SQLException, NoSuchElementException {
        synchronized (lock) {
            if (!entriesByName.containsKey(name)) {
                throw new NoSuchElementException(name, this);
            }
            dropImpl(indexOf(name));
        }
    }

    @Override
    public void dropByIndex(int index) throws SQLException, IndexOutOfBoundsException {
        synchronized (lock) {
            if (index < 0 || index >= namesByIndex.size()) {
                throw new IndexOutOfBoundsException(Integer.toString(index), this);
            }
            dropImpl(index);
        }
    }


    private void dropImpl(int index) throws SQLException {
        dropImpl(index, true);
    }

    private void dropImpl(int index, boolean reallyDrop) throws SQLException {
        String name = namesByIndex.get(index);
        if (reallyDrop) {
            dropObject(index, name);
        }
        namesByIndex.remove(index);
        XPropertySet propertySet = entriesByName.remove(name);
        CompHelper.disposeComponent(propertySet);

        ContainerEvent event = new ContainerEvent(this, name, null, null);
        for (Iterator<?> iterator = containerListeners.iterator(); iterator.hasNext(); ) {
            XContainerListener listener = (XContainerListener) iterator.next();
            listener.elementRemoved(event);
        }
    }

    // XColumnLocate

    @Override
    public int findColumn(String name) throws SQLException {
        if (!entriesByName.containsKey(name)) {
            String error = SharedResources.getInstance().getResourceStringWithSubstitution(
                    Resources.STR_UNKNOWN_COLUMN_NAME, "$columnname$", name);
            throw new SQLException(error, this, StandardSQLState.SQL_COLUMN_NOT_FOUND.text(), 0, null);
        }
        return indexOf(name) + 1; // because columns start at one
    }


    // XEnumerationAccess

    @Override
    public XEnumeration createEnumeration() {
        return new OEnumerationByIndex(this);
    }

    @Override
    public void addContainerListener(XContainerListener listener) {
        containerListeners.add(listener);
    }

    @Override
    public void removeContainerListener(XContainerListener listener) {
        containerListeners.remove(listener);
    }

    @Override
    public Type getElementType() {
        return new Type(XPropertySet.class);
    }

    @Override
    public boolean hasElements() {
        synchronized (lock) {
            return !entriesByName.isEmpty();
        }
    }

    protected int indexOf(String name) {
        for (int i = 0; i < namesByIndex.size(); i++) {
            if (namesByIndex.get(i).equals(name)) {
                return i;
            }
        }
        return -1;
    }

    /** return the object, if not existent it creates it.
     * @param  index
     *     The index of the object to create.
     * @return ObjectType
     */
    protected Object getObject(int index) throws WrappedTargetException {
        String name = namesByIndex.get(index);
        XPropertySet propertySet = entriesByName.get(name);
        if (propertySet == null) {
            try {
                propertySet = createObject(name);
            } catch (SQLException e) {
                try {
                    dropImpl(index, false);
                } catch (Exception ignored) {
                }
                throw new WrappedTargetException(e.getMessage(), this, e);
            }
            entriesByName.put(name, propertySet);
        }
        return propertySet;
    }

    /** clones the given descriptor
     *
     * The method calls createDescriptor to create a new, empty descriptor, and then copies all properties from
     * descriptor to the new object, which is returned.
     *
     * This method might come handy in derived classes for implementing appendObject, when the object
     * is not actually appended to any backend (e.g. for the columns collection of a descriptor object itself,
     * where there is not yet a database backend to append the column to).
     */
    protected XPropertySet cloneDescriptor(XPropertySet descriptor) {
        XPropertySet newDescriptor = createDescriptor();
        CompHelper.copyProperties(descriptor, newDescriptor);
        return newDescriptor;
    }

    protected boolean isCaseSensitive() {
        return isCaseSensitive;
    }

    /** returns the name for the object. The default implementation ask for the property "Name". If this doesn't satisfy, it has to be overloaded.
     * @param  object    The object where the name should be extracted.
     * @return The name of the object.
     */
    protected String getNameForObject(XPropertySet object) throws SQLException {
        try {
            Object name = object.getPropertyValue(PropertyIds.NAME.name);
            return AnyConverter.toString(name);
        } catch (WrappedTargetException | UnknownPropertyException | IllegalArgumentException exception) {
            throw new SQLException("Error", this, StandardSQLState.SQL_GENERAL_ERROR.text(), 0, exception);
        }
    }

    /// Will be called when a object was requested by one of the accessing methods like getByIndex.
    protected abstract XPropertySet createObject(final String name) throws SQLException;

    /// Called when XDrop was called.
    protected abstract void dropObject(int index, String name) throws SQLException;

    // The implementing class should refresh their elements.
    protected abstract void impl_refresh();

    /** Will be called when a new object should be generated by a call of createDataDescriptor;
     *
     * @return
     * the returned object, empty, to be filled, and added to the collection.
     */
    protected abstract XPropertySet createDescriptor();

    /** appends an object described by a descriptor, under a given name
        @param _rForName
            is the name under which the object should be appended. Guaranteed to not be empty.
            This is passed for convenience only, since it's the result of a call of
            getNameForObject for the given descriptor
        @param descriptor
            describes the object to append
        @return
            the new object which is to be inserted into the collection. This might be the result
            of a call of <code>createObject( _rForName )</code>, or a clone of the descriptor.
    */
    protected abstract XPropertySet appendObject(String _rForName, XPropertySet descriptor) throws SQLException;

}