io.vertigo.dynamo.domain.metamodel.Property Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertigo-dynamo-api Show documentation
There is a newer version: 2.1.0
/**
 * vertigo - simple java starter
 *
 * Copyright (C) 2013, KleeGroup, [email protected] (http://www.kleegroup.com)
 * KleeGroup, Centre d'affaire la Boursidiere - BP 159 - 92357 Le Plessis Robinson Cedex - France
 *
 * 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 io.vertigo.dynamo.domain.metamodel;

import io.vertigo.lang.Assertion;

/**
 * Propriété (meta-data, aspect, attribute) transverse gérée par l'application.
 * Certaines propriétés sont nativement gérées par Dynamo,
 * elles sont listées sous formes de constantes.
 * 


 * Exemple : le caractère obligatoire d'un champ est déclaré au niveau du modèle,
 * grâce à la propriété NOT_NULL. Cette information est utilisée pour
 * 
 * automatiser les tests métier unitaires coté serveur,
 * automatiser les tests de surface coté client (En utilisant par exemple le javascript),
 * modifier l'affichage de façon à renseigner l'utilisateur sur le caractère
 *      obligatoire du champ. (Exemple : libellé en gras ou astérisque à coté du champ

 * Cette information ou propriété peut être directement portée par le champ voire
 * plus efficace portée par un domaine métier.
 * 

 * La finalité du domaine métier étant de dépasser les simples types techniques
 * afin de les enrichir avec une forte sémantique (le caractère obligatoire par exemple).
 * 

 * Cette riche sémantique étant utilisée de manière automatique et transparente
 * dans le framework Dynamo ou le framework commun de l'application.
 *
 * @author  pchretien
 */
public final class Property {
	/**
	 * Classe java représentant le type de la propriété.
	 */
	private final Class clazz;
	private final String name;

	/**
	 * Constructeur à partir du nom évocateur de la propriété.
	 * @param clazz Classe java représentant le type de la propriété.
	 */
	public Property(final String name, final Class clazz) {
		Assertion.checkArgNotEmpty(name);
		Assertion.checkNotNull(clazz);
		//-----
		this.clazz = clazz;
		this.name = name;
	}

	/**
	 * @return Nom de la propriété
	 */
	public String getName() {
		return name;
	}

	/**
	* @return Classe java représentant le type de la propriété.
	*/
	public Class getType() {
		return clazz;
	}
}