io.vertigo.dynamo.domain.model.DtListURI 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: 0.9.3
/**
 * 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.model;

import io.vertigo.core.spaces.definiton.DefinitionReference;
import io.vertigo.dynamo.domain.metamodel.DtDefinition;
import io.vertigo.dynamo.domain.metamodel.association.DtListURIForNNAssociation;
import io.vertigo.dynamo.domain.metamodel.association.DtListURIForSimpleAssociation;
import io.vertigo.lang.Assertion;

import java.io.Serializable;
import java.util.regex.Pattern;

/**
 * URI d'une DTC.
 *
 * @author pchretien
 */
public abstract class DtListURI implements Serializable {
	/**
	 * Expression régulière vérifiée par les URN.
	 */
	public static final Pattern REGEX_URN = Pattern.compile("[a-zA-Z0-9_:@$-]{5,80}");
	private static final long serialVersionUID = -1L;
	private final DefinitionReference dtDefinitionRef;

	/**
	 * URN de la ressource (Nom complet)
	 */
	private transient String urn;

	/**
	 * Constructeur.
	 * @param dtDefinition Definition de la ressource
	 */
	public DtListURI(final DtDefinition dtDefinition) {
		dtDefinitionRef = new DefinitionReference<>(dtDefinition);
	}

	/**
	 * @return Définition de la ressource.
	 */
	public DtDefinition getDtDefinition() {
		return dtDefinitionRef.get();
	}

	/** {@inheritDoc} */
	@Override
	public final int hashCode() {
		return toURN().hashCode();
	}

	/** {@inheritDoc} */
	@Override
	public final boolean equals(final Object o) {
		if (o instanceof DtListURI) {
			return ((DtListURI) o).toURN().equals(toURN());
		}
		return false;
	}

	/**
	 * Construit une URN à partir de l'URI.
	 * Une URN est la  représentation unique d'une URI sous forme de chaine de caractères.
	 * Cette chaine peut s'insérer telle que dans une URL en tant que paramètre
	 * et ne contient donc aucun caractère spécial.
	 * Une URN respecte la regex exprimée ci dessus.
	 * @return URN de la ressource.
	 * @deprecated cette URN n'est pas déserializable, ne plus utiliser.
	 */
	@Deprecated
	public final synchronized String toURN() {
		//synchronized car appellée par des traitements métiers (notament le dataStore)
		if (urn == null) {
			urn = DtListURICodec.writeURN(this);
			Assertion.checkArgument(REGEX_URN.matcher(urn).matches(), "urn {0} doit matcher le pattern {1}", urn, REGEX_URN);
		}
		return urn;
	}

	/** {@inheritDoc} */
	@Override
	public final String toString() {
		//on surcharge le toString car il est utilisé dans les logs d'erreur. et celui par défaut utilise le hashcode.
		return "urn[" + getClass().getName() + "]::" + toURN();
	}

	/**
	 * Codec de l'URI en URN.
	 */
	static final class DtListURICodec {
		private static final char D2A_SEPARATOR = '@';
		private static final String CRITERIA_PREFIX = "CRITERIA";

		private DtListURICodec() {
			//private
		}

		/**
		 * @param uri Uri to encode
		 * @return Urn
		 */
		static String writeURN(final DtListURI uri) {
			if (uri instanceof DtListURIForNNAssociation) {
				return writeDtListURNForNNAssociation(DtListURIForNNAssociation.class.cast(uri));
			} else if (uri instanceof DtListURIForSimpleAssociation) {
				return writeDtListURNForSimpleAssociation(DtListURIForSimpleAssociation.class.cast(uri));
			} else if (uri instanceof DtListURIForMasterData) {
				return writeDtListURNForMasterData(DtListURIForMasterData.class.cast(uri));
			} else if (uri instanceof DtListURIForCriteria) {
				return writeDtListURNForDtCriteria(DtListURIForCriteria.class.cast(uri));
			}
			throw new IllegalArgumentException("uri " + uri.getClass().getName() + " non serializable");
		}

		/**
		 * Ecriture d'une URI sous forme d'une URN (chaine de caractères).
		 *
		 * @param uri URI à transcrire
		 * @return URN
		 */
		private static String writeDtListURNForNNAssociation(final DtListURIForNNAssociation uri) {
			return uri.getAssociationDefinition().getName() + D2A_SEPARATOR + uri.getRoleName() + D2A_SEPARATOR + uri.getSource().toURN();
		}

		/**
		 * Ecriture d'une URI sous forme d'une URN (chaine de caractères).
		 *
		 * @param uri URI à transcrire
		 * @return URN
		 */
		private static String writeDtListURNForSimpleAssociation(final DtListURIForSimpleAssociation uri) {
			return uri.getAssociationDefinition().getName() + D2A_SEPARATOR + uri.getRoleName() + D2A_SEPARATOR + uri.getSource().toURN();
		}

		/**
		 * Ecriture d'une URI sous forme d'une URN (chaine de caractères).
		 *
		 * @param uri URI à transcrire
		 * @return URN
		 */
		private static String writeDtListURNForMasterData(final DtListURIForMasterData uri) {
			if (uri.getCode() == null) {
				return uri.getDtDefinition().getName();
			}
			return uri.getDtDefinition().getName() + D2A_SEPARATOR + uri.getCode();
		}

		/**
		 * Ecriture d'une URI sous forme d'une URN (chaine de caractères).
		 *
		 * @param uri URI à transcrire
		 * @return URN
		 */
		private static String writeDtListURNForDtCriteria(final DtListURIForCriteria uri) {
			if (uri.getCriteria() == null) {
				return CRITERIA_PREFIX;
			}
			return CRITERIA_PREFIX + D2A_SEPARATOR + +uri.getCriteria().hashCode();
		}
	}
}