com.tools20022.metamodel.MMBusinessComponent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tools20022-api-payments Show documentation
Java API for ISO 20022 - Payments business domain
The newest version!
/* Tools20022 - API for ISO 20022
* Copyright (C) 2017 Tools20022.com - László Bukodi 
* 
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU 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 General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see .
*/

package com.tools20022.metamodel;

import com.tools20022.core.metamodel.Containment;
import com.tools20022.core.metamodel.Metamodel.MetamodelAttribute;
import com.tools20022.core.metamodel.Metamodel.MetamodelConstraint;
import com.tools20022.core.metamodel.Metamodel.MetamodelType;
import com.tools20022.core.metamodel.Opposite;
import com.tools20022.core.metamodel.RuntimeInstanceAware;
import static com.tools20022.core.metamodel.StaticMemembersBuilder.newAttribute;
import static com.tools20022.core.metamodel.StaticMemembersBuilder.newConstraint;
import com.tools20022.metamodel.constraints.BusinessElementsHaveUniqueNames;
import com.tools20022.metamodel.*;
import java.util.Collections;
import java.util.Date;
import java.util.function.Supplier;
import java.util.List;
import java.util.Optional;

/**
 * Representation of a (part of a) key business notion, characterized by
 * specific BusinessElements.
 */
public class MMBusinessComponent implements RuntimeInstanceAware, MMTopLevelDictionaryEntry, MMBusinessElementType, MMBusinessConcept {

	/**
	 * The BusinessComponents that specialize this BusinessComponent.
	 */
	public final static MetamodelAttribute> subTypeAttribute = newAttribute();
	/**
	 * The BusinessComponent that is specialized by this BusinessComponent.
	 */
	public final static MetamodelAttribute> superTypeAttribute = newAttribute();
	/**
	 * A semantic property of a BusinessComponent.
	 */
	public final static MetamodelAttribute> elementAttribute = newAttribute();
	/**
	 * All of the MessageComponentTypes that derive from this BusinessComponent.
	 */
	public final static MetamodelAttribute> derivationComponentAttribute = newAttribute();
	/**
	 * Describes the semantics that determine how the BusinessComponent may
	 * participate in the BusinessAssociation.
	 */
	public final static MetamodelAttribute> associationDomainAttribute = newAttribute();
	/**
	 * All of the MessageElements that derive from this BusinessComponent.
	 */
	public final static MetamodelAttribute> derivationElementAttribute = newAttribute();
	/**
	 * All BusinessElements contained by this BusinessComponents have different
	 * names element->forAll(el1,el2 : BusinessElement| el1 <> el2
	 * implies el1.name <> el2.name)
	 */
	public final static MetamodelConstraint checkBusinessElementsHaveUniqueNames = newConstraint(b -> {
		new BusinessElementsHaveUniqueNames().accept(b);
	});
	protected Supplier> subType_lazy;
	protected Supplier superType_lazy;
	protected Supplier> element_lazy;
	protected Supplier> derivationComponent_lazy;
	protected Supplier> associationDomain_lazy;
	protected Supplier> derivationElement_lazy;
	protected Supplier dataDictionary_lazy;
	protected String name;
	protected String definition;
	protected Supplier> semanticMarkup_lazy;
	protected Supplier> doclet_lazy;
	protected List example;
	protected Supplier> constraint_lazy;
	protected MMRegistrationStatus registrationStatus;
	protected Date removalDate;
	protected Supplier> nextVersions_lazy;
	protected Supplier previousVersion_lazy;
	protected String objectIdentifier;

	@Override
	public MMDataDictionary getContainer() {
		return getDataDictionary();
	}

	@Override
	public MetamodelType getMetamodel() {
		return StandardMetamodel2013.metamodel().getTypeByClass(getClass());
	}

	public static MetamodelType metaType() {
		return StandardMetamodel2013.metamodel().getTypeByClass(MMBusinessComponent.class);
	}

	/**
	 * The BusinessComponents that specialize this BusinessComponent.
	 * 
	 * @see MMBusinessComponent#getSuperType()
	 */
	@Opposite(bean = MMBusinessComponent.class, attribute = "superType")
	public List getSubType() {
		return subType_lazy == null ? Collections.emptyList() : subType_lazy.get();
	}

	/**
	 * The BusinessComponent that is specialized by this BusinessComponent.
	 * 
	 * @see MMBusinessComponent#getSubType()
	 */
	@Opposite(bean = MMBusinessComponent.class, attribute = "subType")
	public Optional getSuperType() {
		return superType_lazy == null ? Optional.empty() : Optional.of(superType_lazy.get());
	}

	/**
	 * A semantic property of a BusinessComponent.
	 * 
	 * @see MMBusinessElement#getElementContext()
	 */
	@Opposite(bean = MMBusinessElement.class, attribute = "elementContext")
	@Containment
	public List getElement() {
		return element_lazy == null ? Collections.emptyList() : element_lazy.get();
	}

	/**
	 * All of the MessageComponentTypes that derive from this BusinessComponent.
	 * 
	 * @see MMMessageComponentType#getTrace()
	 */
	@Opposite(bean = MMMessageComponentType.class, attribute = "trace")
	public List getDerivationComponent() {
		return derivationComponent_lazy == null ? Collections.emptyList() : derivationComponent_lazy.get();
	}

	/**
	 * Describes the semantics that determine how the BusinessComponent may
	 * participate in the BusinessAssociation.
	 * 
	 * @see MMBusinessAssociationEnd#getType()
	 */
	@Opposite(bean = MMBusinessAssociationEnd.class, attribute = "type")
	public List getAssociationDomain() {
		return associationDomain_lazy == null ? Collections.emptyList() : associationDomain_lazy.get();
	}

	/**
	 * All of the MessageElements that derive from this BusinessComponent.
	 * 
	 * @see MMMessageElement#getBusinessComponentTrace()
	 */
	@Opposite(bean = MMMessageElement.class, attribute = "businessComponentTrace")
	public List getDerivationElement() {
		return derivationElement_lazy == null ? Collections.emptyList() : derivationElement_lazy.get();
	}

	@Override
	public MMDataDictionary getDataDictionary() {
		return dataDictionary_lazy.get();
	}

	@Override
	public String getName() {
		return name;
	}

	@Override
	public Optional getDefinition() {
		return definition == null ? Optional.empty() : Optional.of(definition);
	}

	@Override
	public List getSemanticMarkup() {
		return semanticMarkup_lazy == null ? Collections.emptyList() : semanticMarkup_lazy.get();
	}

	@Override
	public List getDoclet() {
		return doclet_lazy == null ? Collections.emptyList() : doclet_lazy.get();
	}

	@Override
	public List getExample() {
		return example == null ? Collections.emptyList() : example;
	}

	@Override
	public List getConstraint() {
		return constraint_lazy == null ? Collections.emptyList() : constraint_lazy.get();
	}

	@Override
	public MMRegistrationStatus getRegistrationStatus() {
		return registrationStatus;
	}

	@Override
	public Optional getRemovalDate() {
		return removalDate == null ? Optional.empty() : Optional.of(removalDate);
	}

	@Override
	public List getNextVersions() {
		return nextVersions_lazy == null ? Collections.emptyList() : nextVersions_lazy.get();
	}

	@Override
	public Optional getPreviousVersion() {
		return previousVersion_lazy == null ? Optional.empty() : Optional.of(previousVersion_lazy.get());
	}

	@Override
	public Optional getObjectIdentifier() {
		return objectIdentifier == null ? Optional.empty() : Optional.of(objectIdentifier);
	}
}