LegacyRelationMetaData.java
/*
** Module : LegacyRelationMetaData.java
** Abstract : Helper class to provide details about a legacy relation in the open client.
**
** Copyright (c) 2022-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA 20220527 Created initial version.
** 002 CA 20230221 Encapsulated the field and relation metadata in their own classes, to avoid the DataObject
** overhead and increase performance. Other performance optimizations.
*/
/*
** 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.util;
/**
* Helper class to provide details about a relation's metadata.
*/
public class LegacyRelationMetaData
{
/** The relation name. */
private final String name;
/** The parent table name. */
private final String parentBuffer;
/** The child table name. */
private final String childBuffer;
/** The where condition. */
private final String whereString;
/** The relation's active flag. */
private final boolean active;
/** The relation's parentId option. */
private final boolean parentId;
/** The relation's field pairs. */
private final String pairs;
/** The relation's fkeyHidden option. */
private final boolean fkeyHidden;
/** The relation's recursive option. */
private final boolean recursive;
/** The relation's nested option. */
private final boolean nested;
/** The relation's reposition option. */
private final boolean reposition;
/**
*
* @param name
* The relation name.
* @param parentBuffer
* The parent table name.
* @param childBuffer
* The child table name.
* @param whereString
* The where condition.
* @param active
* The relation's active flag.
* @param parentId
* The relation's parentId option.
* @param pairs
* The relation's field pairs.
* @param fkeyHidden
* The relation's fkeyHidden option.
* @param recursive
* The relation's recursive option.
* @param nested
* The relation's nested option.
* @param reposition
* The relation's reposition option.
*/
public LegacyRelationMetaData(String name,
String parentBuffer,
String childBuffer,
String whereString,
boolean active,
boolean parentId,
String pairs,
boolean fkeyHidden,
boolean recursive,
boolean nested,
boolean reposition)
{
this.name = name;
this.parentBuffer = parentBuffer;
this.childBuffer = childBuffer;
this.whereString = whereString;
this.active = active;
this.parentId = parentId;
this.pairs = pairs;
this.fkeyHidden = fkeyHidden;
this.recursive = recursive;
this.nested = nested;
this.reposition = reposition;
}
/**
* Get the relation's name.
*
* @return See above.
*/
public String getName()
{
return name;
}
/**
* Get the relation's parent table.
*
* @return See above.
*/
public String getParent()
{
return parentBuffer;
}
/**
* Get the relation's child table.
*
* @return See above.
*/
public String getChild()
{
return childBuffer;
}
/**
* Get the relation's where string.
*
* @return See above.
*/
public String getWhereString()
{
return whereString;
}
/**
* Get the relation's active flag.
*
* @return See above.
*/
public boolean isActive()
{
return active;
}
/**
* Get the relation's parentId option.
*
* @return See above.
*/
public boolean isParentId()
{
return parentId;
}
/**
* Get the relation's field pairs.
*
* @return See above.
*/
public String getPairs()
{
return pairs;
}
/**
* Get the relation's fkeyHidden option.
*
* @return See above.
*/
public boolean isFkeyHidden()
{
return fkeyHidden;
}
/**
* Get the relation's recursive option.
*
* @return See above.
*/
public boolean isRecursive()
{
return recursive;
}
/**
* Get the relation's nested option.
*
* @return See above.
*/
public boolean isNested()
{
return nested;
}
/**
* Get the relation's reposition option.
*
* @return See above.
*/
public boolean isReposition()
{
return reposition;
}
}