RecordSerializer.java
/*
** Module : RecordSerializer.java
** Abstract : A serializer and parser for FWD Record instances.
**
** Copyright (c) 2022-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA 20220323 Created initial version.
** TJD 20220504 Java 11 compatibility minor changes
** 002 SBI 20230226 Changed to use PropertiesDescriptor to get properties values.
** 003 TJD 20240123 Java 17 compatibility updates
*/
/*
** 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.rest.serializers;
import java.util.*;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.node.*;
import com.goldencode.p2j.persist.*;
import com.goldencode.p2j.persist.Record;
import com.goldencode.p2j.persist.orm.*;
import com.goldencode.p2j.rest.*;
/**
* A parser and serializer for {@link DataModelObject} instances.
*/
public class RecordSerializer
extends JavaTypeSerializer<DataModelObject>
{
/**
* Create a new serializer for {@link DataModelObject} type.
*/
public RecordSerializer()
{
super(DataModelObject.class);
}
/**
* Create an initial (default) instance for this serializer.
* <p>
* this will create a new record of the given type and initialize its fields with the default values.
*
* @param definitionType
* The type as it appears at the parameter's definition.
*
* @return <code>null</code> for immutable types, a Java native value for native types or a new instance,
* for mutable types.
*
* @throws ReflectiveOperationException
*/
@Override
public DataModelObject initialize(Class<? extends DataModelObject> definitionType)
throws ReflectiveOperationException
{
Record record = newRecord(definitionType);
return (DataModelObject) record;
}
/**
* Parse the string JSON representation and assign it to the given argument. The DMO argument will be
* populated with the fields as read from the JSON object - the keys are always the legacy field names,
* case-sensitive.
*
* @param arg
* The argument (obtained via {@link #initialize}.
* @param sval
* The string JSON representation of this argument.
*
* @return The argument instance.
*
* @throws RequestArgumentError
* If the argument can't be parsed.
*/
@Override
public DataModelObject fromJson(DataModelObject arg, String sval)
throws RequestArgumentError
{
// read all properties as string. these will be deserialized by the record
Map<String, Object> props = readMap(STRING_SERIALIZER, null, sval, HashMap.class);
((Record) arg).setPropertyValues(props, (PropertyMeta pm, Object val) ->
{
JavaTypeSerializer serializer;
Class<?> atype;
if (pm.getExtent() > 0)
{
serializer = getSerializer(pm.getType().getTypeName() + "[]", pm.getExtent());
atype = serializer.getType();
}
else
{
serializer = getSerializer(pm.getType().getTypeName());
atype = pm.getType();
}
try
{
Object farg = serializer.initialize(atype);
String fval = val == null ? null : val.toString();
farg = serializer.fromJson(farg, fval);
return farg;
}
catch (ReflectiveOperationException |
RequestArgumentError e)
{
throw new RuntimeException(e);
}
});
return arg;
}
/**
* Serialize the given instance to JSON.
* <p>
* The JSON object will have as keys the record's legacy field names, case-sensitive.
*
* @param val
* The instance to serialize.
*
* @return The JSON representation of this instance.
*/
@Override
public JsonNode toJson(DataModelObject val)
{
ObjectNode res = JsonNodeFactory.instance.objectNode();
if (val instanceof PropertiesDescriptor)
{
Map<String, Object> props = ((PropertiesDescriptor) val).getPropertyValues();
for (Map.Entry<String, Object> entry : props.entrySet())
{
String prop = entry.getKey();
Object value = entry.getValue();
JsonNode node;
if (value == null)
{
node = JsonNodeFactory.instance.nullNode();
}
else
{
JavaTypeSerializer fieldSerializer = getSerializer(value.getClass().getTypeName(), -1);
node = fieldSerializer.toJson(value);
}
res.set(prop, node);
}
}
return res;
}
}