All Downloads are FREE. Search and download functionalities are using the official Maven repository.

it.tidalwave.semantic.EntityFactory Maven / Gradle / Ivy

The newest version!
/***********************************************************************************************************************
 *
 * blueMarine Semantic - open source media workflow
 * Copyright (C) 2008-2011 by Tidalwave s.a.s. (http://www.tidalwave.it)
 *
 ***********************************************************************************************************************
 *
 * 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.
 *
 ***********************************************************************************************************************
 *
 * WWW: http://bluemarine.tidalwave.it
 * SCM: https://kenai.com/hg/bluemarine~semantic-src
 *
 **********************************************************************************************************************/
package it.tidalwave.semantic;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.xml.namespace.QName;
import org.openide.util.Parameters;
import it.tidalwave.util.NotFoundException;
import it.tidalwave.openrdf.elmo.impl.ElmoEntityFactory;

/***********************************************************************************************************************
 *
 * @author  Fabrizio Giudici
 * @version $Id: EntityFactory.java,v 4fbb06e9364c 2011/03/06 21:25:16 fabrizio $
 *
 **********************************************************************************************************************/
public abstract class EntityFactory
  {
    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    static public interface EntityInitializer
      {
        public void initialize (@Nonnull K entity);
      }

    private static final EntityInitializer EMPTY_INITIALIZER = new EntityInitializer()
      {
        @Override
        public void initialize (final @Nonnull Object entity)
          {
          }
      };

    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    @Nonnull
    public static final  EntityInitializer emptyInitializer()
      {
        return (EntityInitializer)EMPTY_INITIALIZER;
      }

    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    public final static class Builder
      {
        @Nonnull
        private final Class interfaceClass;

        @CheckForNull
        private Class implementationClass;

        @CheckForNull
        private Class[] extraClasses;

        /***************************************************************************************************************
         *
         *
         **************************************************************************************************************/
        protected Builder (final @Nonnull Class interfaceClass)
          {
            Parameters.notNull("interfaceClass", interfaceClass);
            this.interfaceClass = interfaceClass;
          }

        /***************************************************************************************************************
         *
         *
         **************************************************************************************************************/
        @Nonnull
        public Builder withImplementation (final @Nonnull Class implementationClass)
          {
            Parameters.notNull("implementationClass", implementationClass);
            this.implementationClass = implementationClass;
            return this;
          }

        /***************************************************************************************************************
         *
         *
         **************************************************************************************************************/
        @Nonnull
        public Builder andRoles (final @Nonnull Class ... extraClasses)
          {
            this.extraClasses = extraClasses.clone();
            return this;
          }

        /***************************************************************************************************************
         *
         *
         **************************************************************************************************************/
        @Nonnull
        public EntityFactory create()
          {
            return new ElmoEntityFactory(interfaceClass, implementationClass, extraClasses);
//            return new ElmoEntityFactory(interfaceClass, implementationClass, extraClasses);
          }
      }

    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    @Nonnull
    public static  Builder forInterface (final @Nonnull Class interfaceClass)
      {
        return new Builder(interfaceClass);
      }
    
    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    @Nonnull
    public abstract T create (@Nonnull QName qName);

    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    @Nonnull
    public abstract T create (@Nonnull QName qName, @Nonnull EntityInitializer initializer);

    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    @Nonnull
    public abstract T find (@Nonnull QName qName)
      throws NotFoundException;

    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    @Nonnull
    public abstract T findOrCreate (@Nonnull QName paramQName);

    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    @Nonnull
    public abstract T findOrCreate (@Nonnull QName paramQName, @Nonnull EntityInitializer paramEntityInitializer);
  }