Parameter.java
/*
** Module : Parameter.java
** Abstract : Implementation of the Progress.Reflect.Parameter builtin class.
**
** Copyright (c) 2020-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------------Description---------------------------------------
** 001 ME 20200422 First version.
** 002 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
** signature.
** 003 ME 20230829 Added default ctor and set properties according to parameter signature.
** ME 20230904 Override toString to use the string representation in method signature.
** ME 20230918 Cache string representation, fix parameter mode enum mapping.
** 004 CA 20231130 Do not use 'TypeFactory.object' in cases where the skeleton class is not instantiated via
** ObjectOps (like the reflection classes), as this will force pending ObjectOps scopeable
** registration, which never gets executed, as the legacy constructors are not used.
** 005 CA 20231106 Properly report DATASET/TABLE/-HANDLE parameters.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero 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 Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.oo.reflect;
import com.goldencode.p2j.util.*;
import static com.goldencode.p2j.report.ReportConstants.CVT_LVL_FULL;
import static com.goldencode.p2j.report.ReportConstants.RT_LVL_FULL;
import static com.goldencode.p2j.util.InternalEntry.Type;
import java.lang.reflect.*;
import com.goldencode.p2j.oo.lang.LegacyEnum;
import com.goldencode.p2j.persist.*;
/**
* Business logic (converted to Java from the 4GL source code
* in abl/skeleton/oo4gl/Progress/Reflect/Parameter.cls).
*/
@LegacyResource(resource = "Progress.Reflect.Parameter")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public class Parameter
extends com.goldencode.p2j.oo.lang.BaseObject
{
private object<? extends DataType> dataType = new object<>(DataType.class);
private character dataTypeName = TypeFactory.character();
private integer extent = TypeFactory.integer();
private character name = TypeFactory.character();
private object<? extends ParameterMode> mode = new object<>(ParameterMode.class);
private integer position = TypeFactory.integer();
private String txtSig;
public Parameter (int position, LegacyParameter legacyParam, Method mthd) {
this.position.assign(position + 1);
this.name.assign(getName(legacyParam));
this.mode.assign(getMode(legacyParam));
java.lang.reflect.Parameter mthdParam = mthd.getParameters()[position];
Class<?> mthdParamType = mthdParam.getType();
if (DataSetParameter.class.isAssignableFrom(mthdParamType))
{
if (InputDataSetHandle.class == mthdParamType ||
OutputDataSetHandle.class == mthdParamType ||
InputOutputDataSetHandle.class == mthdParamType)
{
this.dataType.assign(DataType.dataSetHandle);
}
else
{
this.dataType.assign(DataType.dataSet);
}
}
else if (TableParameter.class.isAssignableFrom(mthdParamType))
{
if (InputTableHandle.class == mthdParamType ||
OutputTableHandle.class == mthdParamType ||
InputTableHandle.class == mthdParamType)
{
this.dataType.assign(DataType.tableHandle);
}
else
{
this.dataType.assign(DataType.table);
}
}
else
{
this.dataType.assign(DataType.getEnum(new character(legacyParam.type())));
}
this.dataTypeName.assign(legacyParam.qualified() == null || legacyParam.qualified().isEmpty() ? null : legacyParam.qualified());
// extends is unknown if size not set, 0 if not an array
if (legacyParam.extent() != -1)
{
this.extent.assign(Math.max(legacyParam.extent(), 0));
}
}
@LegacySignature(returns = "OBJECT", qualified = "Progress.Reflect.DataType", type = Type.GETTER, name = "DataType")
public object<? extends DataType> getDataType()
{
return DataType.getEnum(dataType.ref().getValue());
}
@LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "DataTypeName")
public character getDataTypeName()
{
return dataTypeName.duplicate();
}
@LegacySignature(returns = "INTEGER", type = Type.GETTER, name = "Extent")
public integer getExtent()
{
return extent.duplicate();
}
@LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "Name")
public character getName()
{
return name.duplicate();
}
@LegacySignature(returns = "OBJECT", qualified = "Progress.Reflect.ParameterMode", type = Type.GETTER, name = "Mode")
public object<? extends ParameterMode> getMode()
{
return ParameterMode.getEnum(mode.ref().getValue());
}
@LegacySignature(returns = "INTEGER", type = Type.GETTER, name = "Position")
public integer getPosition()
{
return position.duplicate();
}
@LegacySignature(returns = "CHARACTER", type = Type.METHOD, name = "ToString")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public character toLegacyString()
{
return new character(toString());
}
@Override
public String toString()
{
if (txtSig != null)
{
return txtSig;
}
String type = getEnumValue(getDataType().ref());
StringBuffer sb = new StringBuffer();
if (!"BUFFER".equals(type))
{
sb.append(getMode(mode.ref())).append(" ");
}
if ("BUFFER".equals(type) || "DATASET".equals(type) || "DATASET-HANDLE".equals(type)
|| "TABLE".equals(type) || "TABLE-HANDLE".equals(type))
{
sb.append(type).append(" ");
if ("DATASET".equals(type) || "TABLE".equals(type))
{
sb.append("FOR ");
}
sb.append(name.getValue());
if (mode.ref().isFlagSet(ParameterMode.append).booleanValue())
{
sb.append(" ").append(getEnumValue(ParameterMode.append.ref()));
}
if (mode.ref().isFlagSet(ParameterMode.bind).booleanValue())
{
sb.append(" ").append(getEnumValue(ParameterMode.bind.ref()));
}
} else
{
sb.append(name.getValue()).append(" AS ");
if (dataTypeName.isUnknown())
{
sb.append(type);
} else
{
sb.append(dataTypeName.getValue());
}
}
txtSig = sb.toString();
return txtSig;
}
/**
* Reports if the given instance is managed as part of the legacy 4GL object life cycle. This
* includes reference counting, linking in the SESSION object chain, managed construction and
* destruction.
*
* @return Always {@code false} for 4GL internals (class/reflection).
*/
@Override
public boolean isTracked()
{
return false;
}
private String getMode (ParameterMode pmode) {
if (pmode.isFlagSet(ParameterMode.inputOutput).booleanValue())
{
return "INPUT-OUTPUT";
} else if (pmode.isFlagSet(ParameterMode.output).booleanValue())
{
return "OUTPUT";
}
return "INPUT";
}
private object<? extends ParameterMode> getMode(LegacyParameter legacyParam)
{
String legacyMode = legacyParam.mode() != null ? legacyParam.mode().toUpperCase() : "INPUT";
object<? extends ParameterMode> pmode;
switch (legacyMode)
{
case "INPUT-OUTPUT":
pmode = ParameterMode.inputOutput;
break;
case "OUTPUT":
pmode = ParameterMode.output;
break;
default:
pmode = ParameterMode.input;
break;
}
if (legacyParam.append())
{
pmode.assign(pmode.ref().setFlag(ParameterMode.append));
}
if (legacyParam.bind())
{
pmode.assign(pmode.ref().setFlag(ParameterMode.bind));
}
return pmode;
}
private String getName(LegacyParameter param)
{
// buffer is reported instead of table name
if (!param.buffer().isEmpty())
{
return param.buffer();
} else if (!param.dataset().isEmpty())
{
return param.dataset();
} if (!param.table().isEmpty())
{
return param.table();
}
return param.name();
}
private String getEnumValue(LegacyEnum lenum)
{
return lenum.toLegacyString().getValue().toUpperCase();
}
}