org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of broadleaf-open-admin-platform Show documentation
BroadleafCommerce Open Admin Platform
There is a newer version: 3.1.15-GA
Show newest version
/*
 * Copyright 2008-2013 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.broadleafcommerce.openadmin.server.dao;

import org.broadleafcommerce.common.persistence.EntityConfiguration;
import org.broadleafcommerce.openadmin.dto.ClassTree;
import org.broadleafcommerce.openadmin.dto.FieldMetadata;
import org.broadleafcommerce.openadmin.dto.ForeignKey;
import org.broadleafcommerce.openadmin.dto.MergedPropertyType;
import org.broadleafcommerce.openadmin.dto.PersistencePerspective;
import org.broadleafcommerce.openadmin.server.dao.provider.metadata.FieldMetadataProvider;
import org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager;
import org.hibernate.Criteria;
import org.hibernate.SessionFactory;
import org.hibernate.mapping.PersistentClass;
import org.hibernate.type.Type;

import java.io.Serializable;
import java.lang.reflect.Field;
import java.util.List;
import java.util.Map;

import javax.persistence.EntityManager;

/**
 * 
 * @author jfischer
 *
 */
public interface DynamicEntityDao {

    public abstract Class[] getAllPolymorphicEntitiesFromCeiling(Class ceilingClass);

    public abstract Class[] getAllPolymorphicEntitiesFromCeiling(Class ceilingClass, boolean includeUnqualifiedPolymorphicEntities);

    public ClassTree getClassTreeFromCeiling(Class ceilingClass);

    public ClassTree getClassTree(Class[] polymorphicClasses);
    
    public abstract Map getPropertiesForPrimitiveClass(String propertyName, String friendlyPropertyName, Class targetClass, Class parentClass, MergedPropertyType mergedPropertyType);
    
    public abstract Map getMergedProperties(String ceilingEntityFullyQualifiedClassname, Class[] entities, ForeignKey foreignField, String[] additionalNonPersistentProperties, ForeignKey[] additionalForeignFields, MergedPropertyType mergedPropertyType, Boolean populateManyToOneFields, String[] includeManyToOneFields, String[] excludeManyToOneFields, String configurationKey, String prefix);
    
    public abstract Serializable persist(Serializable entity);
    
    public abstract Serializable merge(Serializable entity);

    public abstract Serializable retrieve(Class entityClass, Object primaryKey);
    
    public abstract void remove(Serializable entity);
    
    public abstract void clear();
    
    public void flush();
    
    public void detach(Serializable entity);
    
    public void refresh(Serializable entity);
    
    public EntityManager getStandardEntityManager();
    
    public void setStandardEntityManager(EntityManager entityManager);

    /**
     * Get the Hibernate PersistentClass instance associated with the fully-qualified
     * class name. Will return null if no persistent class is associated with this name.
     *
     * @param targetClassName
     * @return The PersistentClass instance
     */
    public PersistentClass getPersistentClass(String targetClassName);
    
    public Map getSimpleMergedProperties(String entityName, PersistencePerspective persistencePerspective);

    public FieldManager getFieldManager();

    public EntityConfiguration getEntityConfiguration();

    public void setEntityConfiguration(EntityConfiguration entityConfiguration);

    public Map getIdMetadata(Class entityClass);

    public List getPropertyTypes(Class entityClass);

    public List getPropertyNames(Class entityClass);

    public Criteria createCriteria(Class entityClass);

    public Field[] getAllFields(Class targetClass);

    public Metadata getMetadata();

    public void setMetadata(Metadata metadata);
    
    public FieldMetadataProvider getDefaultFieldMetadataProvider();

    public SessionFactory getSessionFactory();

}