/*
 * 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.uima.fit.component;

import java.util.Map;

import org.apache.uima.fit.component.initialize.ConfigurationParameterInitializer;
import org.apache.uima.fit.descriptor.ConfigurationParameter;
import org.apache.uima.fit.factory.ExternalResourceFactory;
import org.apache.uima.resource.ResourceInitializationException;
import org.apache.uima.resource.ResourceSpecifier;

/**
 * Base class for external resources which initializes itself based on annotations.
 */
public abstract class Resource_ImplBase extends org.apache.uima.resource.Resource_ImplBase
        implements ExternalResourceAware {
  @ConfigurationParameter(name = ExternalResourceFactory.PARAM_RESOURCE_NAME, mandatory = false)
  private String resourceName;

  @Override
  public boolean initialize(final ResourceSpecifier aSpecifier,
          final Map<String, Object> aAdditionalParams) throws ResourceInitializationException {
    if (!super.initialize(aSpecifier, aAdditionalParams)) {
      return false;
    }

    ConfigurationParameterInitializer.initialize(this, aSpecifier);
    // We cannot call ExternalResourceInitializer.initialize() because the
    // ResourceManager_impl has not added the resources to the context yet.
    // Resource initialization is handled by ExternalResourceInitializer.initialize()
    // when it is called on the first pipeline component.

    return true;
  }

  @Override
  public String getResourceName() {
    return resourceName;
  }

  @Override
  public void afterResourcesInitialized() throws ResourceInitializationException {
    // Per default nothing is done here.
  }
}
