org.beangle.commons.entity.metadata.ModelMeta Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of beangle-commons-model Show documentation
The newest version!
/*
 * Beangle, Agile Development Scaffold and Toolkits.
 *
 * Copyright © 2005, The Beangle Software.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */
package org.beangle.commons.entity.metadata;

import java.io.Serializable;

import org.beangle.commons.entity.Entity;

/**
 * Model meta data
 *
 * @author chaostone
 * @since 3.0.0
 */
public interface ModelMeta {

  /**
   * 
   * newInstance.
   * 

   *
   * @param clazz
   * @param  a T object.
   * @return a T object.
   */
  > T newInstance(final Class clazz);

  /**
   * 
   * newInstance.
   * 

   *
   * @param clazz a {@link java.lang.Class} object.
   * @param id a {@link java.io.Serializable} object.
   * @param  a T object.
   * @return a T object.
   */
  , ID extends Serializable> T newInstance(final Class clazz, final ID id);

  /**
   * 
   * getEntityType.
   * 

   *
   * @param entityName a {@link java.lang.String} object.
   * @return a {@link org.beangle.commons.entity.metadata.EntityType} object.
   */
  EntityType getEntityType(String entityName);

  /**
   * 
   * getType.
   * 

   *
   * @param name collectionname or entityname
   */
  Type getType(String name);

  /**
   * 
   * getEntityName.
   * 

   *
   * @param obj a {@link java.lang.Object} object.
   * @return a {@link java.lang.String} object.
   */
  String getEntityName(Object obj);

  /**
   * 
   * getEntityType.
   * 

   *
   * @param clazz a {@link java.lang.Class} object.
   * @return a {@link org.beangle.commons.entity.metadata.EntityType} object.
   */
  EntityType getEntityType(Class clazz);

  /**
   * Returns populator
   */
  Populator getPopulator();
}