Open Source Repository

Home /spring/spring-jdbc-3.0.5 | Repository Home


org/springframework/jdbc/config/EmbeddedDatabaseBeanDefinitionParser.java
/*
 * Copyright 2002-2010 the original author or authors.
 *
 * 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.springframework.jdbc.config;

import java.util.ArrayList;
import java.util.List;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseFactoryBean;
import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator;
import org.springframework.util.StringUtils;
import org.springframework.util.xml.DomUtils;
import org.w3c.dom.Element;

/**
 {@link org.springframework.beans.factory.xml.BeanDefinitionParser} that parses {@code embedded-database} element and
 * creates a {@link BeanDefinition} for {@link EmbeddedDatabaseFactoryBean}. Picks up nested {@code script} elements and
 * configures a {@link ResourceDatabasePopulator} for them.
 
 @author Oliver Gierke
 @since 3.0
 */
class EmbeddedDatabaseBeanDefinitionParser extends AbstractBeanDefinitionParser {

  private static final String NAME_PROPERTY = "databaseName";

  @Override
  protected AbstractBeanDefinition parseInternal(Element element, ParserContext context) {
    BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(EmbeddedDatabaseFactoryBean.class);
    setDatabaseType(element, builder);
    setDatabasePopulator(element, context, builder);
    useIdAsDatabaseNameIfGiven(element, builder);
    return getSourcedBeanDefinition(builder, element, context);
  }

  private void useIdAsDatabaseNameIfGiven(Element element, BeanDefinitionBuilder builder) {

    String id = element.getAttribute(ID_ATTRIBUTE);
    if (StringUtils.hasText(id)) {
      builder.addPropertyValue(NAME_PROPERTY, id);
    }
  }

  private void setDatabaseType(Element element, BeanDefinitionBuilder builder) {
    String type = element.getAttribute("type");
    if (StringUtils.hasText(type)) {
      builder.addPropertyValue("databaseType", type);
    }
  }

  private void setDatabasePopulator(Element element, ParserContext context, BeanDefinitionBuilder builder) {
    List<Element> scripts = DomUtils.getChildElementsByTagName(element, "script");
    if (scripts.size() 0) {
      builder.addPropertyValue("databasePopulator", createDatabasePopulator(scripts, context));
    }
  }

  private BeanDefinition createDatabasePopulator(List<Element> scripts, ParserContext context) {
    BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(ResourceDatabasePopulator.class);
    List<String> locations = new ArrayList<String>();
    for (Element scriptElement : scripts) {
      locations.add(scriptElement.getAttribute("location"));
    }
    // Use a factory bean for the resources so they can be given an order if a pattern is used
    BeanDefinitionBuilder resourcesFactory = BeanDefinitionBuilder
        .genericBeanDefinition(SortedResourcesFactoryBean.class);
    resourcesFactory.addConstructorArgValue(locations);
    builder.addPropertyValue("scripts", resourcesFactory.getBeanDefinition());

    return builder.getBeanDefinition();
  }

  private AbstractBeanDefinition getSourcedBeanDefinition(
      BeanDefinitionBuilder builder, Element source, ParserContext context) {

    AbstractBeanDefinition definition = builder.getBeanDefinition();
    definition.setSource(context.extractSource(source));
    return definition;
  }

}