CaseUsageAdapter.java

/*******************************************************************************
 * SysML 2 Pilot Implementation
 * Copyright (c) 2021, 2023-2024 Model Driven Solutions, Inc.
 *    
 * 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 theGNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *  
 * @license LGPL-3.0-or-later <http://spdx.org/licenses/LGPL-3.0-or-later>
 *  
 *******************************************************************************/

package org.omg.sysml.adapter;

import org.omg.sysml.lang.sysml.CaseDefinition;
import org.omg.sysml.lang.sysml.CaseUsage;
import org.omg.sysml.lang.sysml.Type;
import org.omg.sysml.util.UsageUtil;

public class CaseUsageAdapter extends CalculationUsageAdapter {

	public CaseUsageAdapter(CaseUsage element) {
		super(element);
	}
	
	@Override
	public CaseUsage getTarget() {
		return (CaseUsage)super.getTarget();
	}
	
	// Utility
	
	@Override
	public boolean hasRelevantSubjectParameter() {
		Type owningType = getTarget().getOwningType();
		return owningType instanceof CaseDefinition || owningType instanceof CaseUsage;
	}
	
	// Implicit Generalization
	
	/**
	 * @satisfies checkCaseUsageSpecialization
	 * @satisfies checkCaseUsageSubcaseSpecialization
	 */
	@Override
	protected String getSubactionType() {
		return isSubcase()? "subcase": super.getSubactionType();	
	}
		
	public boolean isSubcase() {
		/*TODO: ST6RI-843
		 * 
		 * checkCaseUsageSubcaseSpecialization
		 * 
		 * isComposite and owningType <> null and 
    	 * (owningType.oclIsKindOf(CaseDefinition) or
         * owningType.oclIsKindOf(CaseUsage)) implies
         * specializesFromLibrary('Cases::Case::subcases')
		 * 
		 * nonEntryExit part of the check is not reflected of the OCL
		 */
		CaseUsage target = getTarget();
		Type owningType = target.getOwningType();
		return isNonEntryExitComposite() &&
			   (owningType instanceof CaseDefinition || owningType instanceof CaseUsage);
	}
	
	// Transformation
	
	@Override 
	public void addAdditionalMembers() {
		CaseUsage usage = getTarget();
		UsageUtil.addSubjectParameterTo(usage);
		UsageUtil.addObjectiveRequirementTo(usage);
		super.addAdditionalMembers();
	}
	
}