DataRelation (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.HandleResource
- - com.goldencode.p2j.persist.DataRelation

All Implemented Interfaces:

DataRelationInterface, QueryAssociable, ADMData, CommonHandle, CommonHandleChain, Deletable, DynamicResource, InstantiatingProcedure, Nameable, WrappedResource, Printable
```
public class DataRelation
extends HandleResource
implements ADMData, CommonHandleChain, DataRelationInterface, DynamicResource, QueryAssociable
```
A DataRelation defines one relation between a pair of parent and child buffers in a DataSet that have a one-to-one or one-to-many parent-child relationship. A DataRelation identifies the parent and child buffers, and the fields in each buffer that define the primary and foreign key fields of the relation.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`active` The ACTIVE status of this relation.
`private java.lang.String`	`admData` Current value of PRIVATE-DATA.
`private java.util.List<java.lang.String>`	`afterFields` The set of AFTER fields.
`private java.util.List<java.lang.String>`	`beforeFields` The set of AFTER fields.
`private BufferImpl`	`childBuffer` The child buffer.
`private DataSet`	`dataSet` The parent `DataSet` where this `DataRelation` is defined.
`private boolean`	`fkHidden` The FOREIGN-KEY-HIDDEN status of this relation.
`private boolean`	`isValid` Flags for valid property.
`private int`	`maximumLevel` The MAXIMUM-LEVEL status of this relation.
`private java.lang.String`	`name` The value of `NAME` attribute.
`private boolean`	`nested` The NESTED status of this relation.
`private BufferImpl`	`parentBuffer` The parent buffer.
`private java.lang.String`	`parentLink` For PARENT-ID relations, this specifies the field that points to parent 'foreign' key.
`private java.lang.String`	`privateData` Current value of PRIVATE-DATA.
`private QueryWrapper`	`query` The current value of `QUERY` attribute.
`private boolean`	`recursive` `true` to flag this as a RECURSIVE relation.
`private static RefCount`	`refCount` Reference counter.
`private java.lang.String[]`	`relationFields` The relation fields for this object.
`private boolean`	`reposition` The REPOSITION status of this relation.
`private java.lang.String`	`whereString` The current value of `WHERE-STRING` attribute.

Fields inherited from class com.goldencode.p2j.util.HandleResource
instProc, pm

Constructor Summary

Constructors
Constructor and Description
`DataRelation(DataSet dataSet, Buffer parent, Buffer child, java.lang.String[] relationFields, java.lang.String strPairs, boolean recursive)` Creates a new simple `DataRelation` based on join between pairs of fields from parent and child buffer.
`DataRelation(DataSet dataSet, Buffer parent, Buffer child, java.lang.String parentLink, java.util.List<java.lang.String> beforeFields, java.util.List<java.lang.String> afterFields, boolean dynamic)` Creates a new simple `DataRelation` based on join between pairs of fields from parent and child buffer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`_dynamic()` Returns `true` if the buffer is dynamic.
`(package private) java.lang.String`	`_getRelationFields()` Extract the list of relation fields.
`(package private) boolean`	`_isActive()` Checks whether this relation is active.
`private boolean`	`_isParentIdRelation()` Internal check whether this is a parent-id-relation.
`boolean`	`_isRecursive()` Checks whether this data-relation is recursive.
`(package private) boolean`	`_isReposition()` Query the current value of `REPOSITION` attribute.
`(package private) void`	`confirmDynamic()` Confirms that this object is dynamic.
`private boolean`	`createQuery(java.lang.String where)` Modifies the current WHERE expression that links the child table to its parent.
`character`	`getADMData()` Get the value of the ADM-DATA attribute.
`handle`	`getChildBuffer()` Obtain the buffer handle of the child member of this data-relation object.
`BufferImpl`	`getChildBufferNative()` Obtain the buffer of the child member of this data-relation object.
`java.lang.String`	`getChildTable()` Obtain the name of the child table.
`handle`	`getCurrentQuery()` Obtain the handle to the `DataSet` query that contains the currently selected row in the `BindingSource`.
`handle`	`getCurrentQuery(long bandIndex)` Obtain the handle to the `DataSet` query that contains the currently selected row in the `BindingSource`.
`handle`	`getCurrentQuery(NumberType bandIndex)` Obtain the handle to the `DataSet` query that contains the currently selected row in the `BindingSource`.
`logical`	`getForeignKeyHidden()` Checks whether the foreign key fields in the child records of a nested data-relation are hidden.
`integer`	`getMaximumLevel()` Obtain the maximum level where a recursive data-relation stops.
`handle`	`getNextSibling()` Get the `NEXT-SIBLING` attribute of this handle.
`handle`	`getParentBuffer()` Obtain the buffer handle of the parent member.
`BufferImpl`	`getParentBufferNative()` Obtain the buffer of the parent member.
`character`	`getParentFieldsAfter()` Obtain a comma-separated list of fields from the parent record in the relation to be written to XML after all nested child records.
`character`	`getParentFieldsBefore()` Obtain a comma-separated list of fields from the parent record in the relation to be written to XML before any nested child records.
`java.lang.String`	`getParentTable()` Obtain the name of the parent table.
`handle`	`getPrevSibling()` Get the `PREV-SIBLING` attribute of this handle.
`character`	`getPrivateData()` Get the `PRIVATE-DATA` attribute of this handle.
`QueryWrapper`	`getQuery()` Get the query associated with this relation.
`handle`	`getQueryAsHandle()` Get the query associated with this relation.
`java.lang.String[]`	`getRelationFieldArray()` The original set of field pairs.
`character`	`getRelationFields()` Obtains a comma-separated list of parent-field, child-field pairs describing the relationship between parent and child buffers as specified in the data-relation object definition.
`java.lang.String[]`	`getRelationFields(boolean parent)` Extracts the list of relation fields for only one of the tables, in form of an array.
`logical`	`getReposition()` Obtain the reposition mode of this data-relation object.
`character`	`getWhereString()` Obtains the current WHERE expression from the query generated that links the child table to its parent.
`protected boolean`	`hasNameConstraints()` Allows each resource to declare whether it has some naming constraints.
`logical`	`isActive()` Corresponds to `ACTIVE` ABL attribute.
`logical`	`isNested()` Checks whether child rows of a `DataSet` temp-table buffer are nested within their parent rows when writing the XML representation of `DataSet` object that contains data-relations.
`logical`	`isParentIdRelation()` Checks whether the relationship between parent and child records is based on the `RECID` type of the parent record.
`logical`	`isRecursive()` Checks whether this data-relation is recursive.
`character`	`name()` Get the `name` attribute of this object.
`void`	`name(character name)` Set the `name` attribute of this object.
`void`	`name(java.lang.String name)` Set the `name` attribute of this object.
`protected boolean`	`resourceDelete()` Worker to be implemented by each resource.
`void`	`setActive(boolean active)` Corresponds to `ACTIVE` ABL attribute.
`void`	`setActive(logical active)` Corresponds to `ACTIVE` ABL attribute.
`void`	`setADMData(character value)` Set the value of the ADM-DATA attribute.
`void`	`setADMData(java.lang.String value)` Set the value of the ADM-DATA attribute.
`void`	`setForeignKeyHidden(boolean hide)` Configures whether the foreign key fields in the child records of a nested data-relation are hidden.
`void`	`setForeignKeyHidden(logical hide)` Configures whether the foreign key fields in the child records of a nested data-relation are hidden.
`void`	`setMaximumLevel(long max)` Configures the maximum level where a recursive data-relation stops.
`void`	`setMaximumLevel(NumberType max)` Configures the maximum level where a recursive data-relation stops.
`void`	`setNested(boolean nested)` Configures whether child rows of a `DataSet` temp-table buffer are nested within their parent rows when writing the XML representation of `DataSet` object that contains data-relations.
`void`	`setNested(logical nested)` Configures whether child rows of a `DataSet` temp-table buffer are nested within their parent rows when writing the XML representation of `DataSet` object that contains data-relations.
`void`	`setPrivateData(character data)` Set the `PRIVATE-DATA` attribute of this handle.
`void`	`setPrivateData(java.lang.String data)` Set the `PRIVATE-DATA` attribute of this handle.
`void`	`setQueryAsHandle(handle qry)` Set the query associated with the given resource.
`void`	`setQueryAsHandle(QueryWrapper qry)` Set the query associated with the given resource.
`void`	`setReposition(boolean reposition)` Sets the reposition mode of this data-relation object.
`void`	`setReposition(logical reposition)` Sets the reposition mode of this data-relation object.
`void`	`setWhereString(java.lang.String where)` Modifies the current WHERE expression that links the child table to its parent.
`void`	`setWhereString(Text where)` Modifies the current WHERE expression that links the child table to its parent.
`java.lang.String`	`toString()` Returns a string representation of this object.
`boolean`	`valid()` Reports if this object is valid for use.

Methods inherited from class com.goldencode.p2j.util.HandleResource
_instantiatingProcedure, addToPool, delete, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, readOnlyError, readOnlyError, registerResource, resourceType, setInstantiatingProcedure, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.util.CommonHandle
readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource
id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.DynamicResource
dynamic

Methods inherited from interface com.goldencode.util.Printable
asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable
allowDelete

- Field Detail
  - dataSet
```
private final DataSet dataSet
```
    The parent DataSet where this DataRelation is defined.
  - parentBuffer
```
private final BufferImpl parentBuffer
```
    The parent buffer.
  - childBuffer
```
private final BufferImpl childBuffer
```
    The child buffer.
  - recursive
```
private final boolean recursive
```
    true to flag this as a RECURSIVE relation.
  - relationFields
```
private final java.lang.String[] relationFields
```
    The relation fields for this object.
  - afterFields
```
private final java.util.List<java.lang.String> afterFields
```
    The set of AFTER fields.
  - beforeFields
```
private final java.util.List<java.lang.String> beforeFields
```
    The set of AFTER fields.
  - parentLink
```
private final java.lang.String parentLink
```
    For PARENT-ID relations, this specifies the field that points to parent 'foreign' key.
  - active
```
private boolean active
```
    The ACTIVE status of this relation.
  - nested
```
private boolean nested
```
    The NESTED status of this relation.
  - reposition
```
private boolean reposition
```
    The REPOSITION status of this relation.
  - fkHidden
```
private boolean fkHidden
```
    The FOREIGN-KEY-HIDDEN status of this relation.
  - maximumLevel
```
private int maximumLevel
```
    The MAXIMUM-LEVEL status of this relation.
  - whereString
```
private java.lang.String whereString
```
    The current value of WHERE-STRING attribute.
  - privateData
```
private java.lang.String privateData
```
    Current value of PRIVATE-DATA.
  - admData
```
private java.lang.String admData
```
    Current value of PRIVATE-DATA.
  - name
```
private java.lang.String name
```
    The value of NAME attribute.
  - isValid
```
private boolean isValid
```
    Flags for valid property. The DataRelations are valid from the moment they are created until the object is dropped/deleted. Once it is deleted and made invalid, the object cannot be made valid again.
  - query
```
private QueryWrapper query
```
    The current value of QUERY attribute. Uses lazy initialization.
  - refCount
```
private static final RefCount refCount
```
    Reference counter. Only used to create incremental names for unnamed (static) DataRelations.
- Constructor Detail
  - DataRelation
```
public DataRelation(DataSet dataSet,
                    Buffer parent,
                    Buffer child,
                    java.lang.String[] relationFields,
                    java.lang.String strPairs,
                    boolean recursive)
```
    Creates a new simple DataRelation based on join between pairs of fields from parent and child buffer. This is the constructor called when a ADD-RELATION method is successful.
    
    Parameters:
    
    dataSet - The DataSet.
    
    parent - The parent buffer.
    
    child - The child buffer.
    
    relationFields - The set of fields. The list has an even number of values, the values on odd indexes being the parent fields and the even ones are the child fields.
    
    strPairs - The pair of fields, as string as they appear in the legacy statement.
    
    recursive - true if this is a recursive relation.
  - DataRelation
```
public DataRelation(DataSet dataSet,
                    Buffer parent,
                    Buffer child,
                    java.lang.String parentLink,
                    java.util.List<java.lang.String> beforeFields,
                    java.util.List<java.lang.String> afterFields,
                    boolean dynamic)
```
    Creates a new simple DataRelation based on join between pairs of fields from parent and child buffer. This is the constructor called when a ADD-PARENT-ID-RELATION method is successful.
    
    Parameters:
    
    parent - The parent buffer.
    
    child - The child buffer.
    
    parentLink - The name of the RECID field of child buffer that is used to join with the parent buffer.
    
    beforeFields - The list of fields to be serialized before.
    
    afterFields - The list of fields to be serialized after.
    
    dynamic - Use true for dynamically created relations.
- Method Detail
  - confirmDynamic
```
void confirmDynamic()
```
    Confirms that this object is dynamic.
    This method finishes setting this object parent-procedure and makes sure it is deleted at the appropriate moment (when the parent dataset is deleted). This is only needed for dynamically created relations.
  - isActive
```
public logical isActive()
```
    Corresponds to ACTIVE ABL attribute. Deactivate an individual data-relation in a DataSet object.
    
    Specified by:
    
    isActive in interface DataRelationInterface
    
    Returns:
    
    the current state of ACTIVE attribute.
  - setActive
```
public void setActive(boolean active)
```
    Corresponds to ACTIVE ABL attribute. Deactivate an individual data-relation in a DataSet object.
    
    Specified by:
    
    setActive in interface DataRelationInterface
    
    Parameters:
    
    active - The new state of ACTIVE attribute.
  - setActive
```
public void setActive(logical active)
```
    Corresponds to ACTIVE ABL attribute. Deactivate an individual data-relation in a DataSet object.
    
    Specified by:
    
    setActive in interface DataRelationInterface
    
    Parameters:
    
    active - The new state of ACTIVE attribute.
  - getChildBuffer
```
public handle getChildBuffer()
```
    Obtain the buffer handle of the child member of this data-relation object. This method corresponds to the real-only CHILD-BUFFER attribute.
    
    Specified by:
    
    getChildBuffer in interface DataRelationInterface
    
    Returns:
    
    the buffer handle of the child member.
  - getChildBufferNative
```
public BufferImpl getChildBufferNative()
```
    Obtain the buffer of the child member of this data-relation object. This method corresponds to the real-only CHILD-BUFFER attribute.
    
    Returns:
    
    the buffer of the child member.
  - getChildTable
```
public java.lang.String getChildTable()
```
    Obtain the name of the child table.
    
    Returns:
    
    the name of the child table.
  - getCurrentQuery
```
public handle getCurrentQuery()
```
    Obtain the handle to the DataSet query that contains the currently selected row in the BindingSource. Corresponds to CURRENT-QUERY ABL method.
    
    Specified by:
    
    getCurrentQuery in interface DataRelationInterface
    
    Returns:
    
    the handle to the DataSet query that contains the currently selected row
  - getCurrentQuery
```
public handle getCurrentQuery(long bandIndex)
```
    Obtain the handle to the DataSet query that contains the currently selected row in the BindingSource. Corresponds to CURRENT-QUERY ABL method.
    
    Specified by:
    
    getCurrentQuery in interface DataRelationInterface
    
    Parameters:
    
    bandIndex - 0-based integer value that specifies the band index in a hierarchical grid
    
    Returns:
    
    the handle to the DataSet query that contains the currently selected row
  - getCurrentQuery
```
public handle getCurrentQuery(NumberType bandIndex)
```
    Obtain the handle to the DataSet query that contains the currently selected row in the BindingSource. Corresponds to CURRENT-QUERY ABL method.
    
    Specified by:
    
    getCurrentQuery in interface DataRelationInterface
    
    Parameters:
    
    bandIndex - 0-based integer value that specifies the band index in a hierarchical grid
    
    Returns:
    
    the handle to the DataSet query that contains the currently selected row
  - getRelationFields
```
public character getRelationFields()
```
    Obtains a comma-separated list of parent-field, child-field pairs describing the relationship between parent and child buffers as specified in the data-relation object definition. Corresponds to RELATION-FIELDS readonly ABL attribute.
    
    Specified by:
    
    getRelationFields in interface DataRelationInterface
    
    Returns:
    
    the set of field pairs that describes the data-relation.
  - getWhereString
```
public character getWhereString()
```
    Obtains the current WHERE expression from the query generated that links the child table to its parent. Corresponds to WHERE-STRING attribute.
    
    Specified by:
    
    getWhereString in interface DataRelationInterface
    
    Returns:
    
    the current WHERE expression that links the child table to its parent.
  - setWhereString
```
public void setWhereString(java.lang.String where)
```
    Modifies the current WHERE expression that links the child table to its parent. This is the setter implementation for WHERE-STRING ABL attribute.
    
    Specified by:
    
    setWhereString in interface DataRelationInterface
    
    Parameters:
    
    where - the new predicate.
  - setWhereString
```
public void setWhereString(Text where)
```
    Modifies the current WHERE expression that links the child table to its parent. This is the setter implementation for WHERE-STRING ABL attribute.
    Unlike other attributes, this attribute can be set tu unknown value!
    
    Specified by:
    
    setWhereString in interface DataRelationInterface
    
    Parameters:
    
    where - the new predicate.
  - getForeignKeyHidden
```
public logical getForeignKeyHidden()
```
    Checks whether the foreign key fields in the child records of a nested data-relation are hidden. This is the getter implementation of the ABL FOREIGN-KEY-HIDDEN attribute.
    
    Specified by:
    
    getForeignKeyHidden in interface DataRelationInterface
    
    Returns:
    
    the current value of FOREIGN-KEY-HIDDEN attribute for this relation.
  - setForeignKeyHidden
```
public void setForeignKeyHidden(boolean hide)
```
    Configures whether the foreign key fields in the child records of a nested data-relation are hidden. This is the setter implementation of the ABL FOREIGN-KEY-HIDDEN attribute.
    
    Specified by:
    
    setForeignKeyHidden in interface DataRelationInterface
    
    Parameters:
    
    hide - the new value of FOREIGN-KEY-HIDDEN attribute of this relation.
  - setForeignKeyHidden
```
public void setForeignKeyHidden(logical hide)
```
    Configures whether the foreign key fields in the child records of a nested data-relation are hidden. This is the setter implementation of the ABL FOREIGN-KEY-HIDDEN attribute.
    
    Specified by:
    
    setForeignKeyHidden in interface DataRelationInterface
    
    Parameters:
    
    hide - the new value of FOREIGN-KEY-HIDDEN attribute of this relation.
  - getMaximumLevel
```
public integer getMaximumLevel()
```
    Obtain the maximum level where a recursive data-relation stops. This is the getter part of the MAXIMUM-LEVEL ABL attribute.
    
    Specified by:
    
    getMaximumLevel in interface DataRelationInterface
    
    Returns:
    
    the number of iterations at which this recursion stops.
  - setMaximumLevel
```
public void setMaximumLevel(NumberType max)
```
    Configures the maximum level where a recursive data-relation stops. This is the setter part of the MAXIMUM-LEVEL ABL attribute.
    
    Specified by:
    
    setMaximumLevel in interface DataRelationInterface
    
    Parameters:
    
    max - the new number of iterations at which the recursion stops.
  - setMaximumLevel
```
public void setMaximumLevel(long max)
```
    Configures the maximum level where a recursive data-relation stops. This is the setter part of the MAXIMUM-LEVEL ABL attribute.
    
    Specified by:
    
    setMaximumLevel in interface DataRelationInterface
    
    Parameters:
    
    max - the new number of iterations at which the recursion stops.
  - getReposition
```
public logical getReposition()
```
    Obtain the reposition mode of this data-relation object. When true, the relation mode is REPOSITION. Otherwise, the relation mode is SELECTION. The default value is false. This is the getter of the REPOSITION attribute.
    
    Specified by:
    
    getReposition in interface DataRelationInterface
    
    Returns:
    
    true when the reposition mode is REPOSITION and false when reposition mode is SELECTION.
  - setReposition
```
public void setReposition(logical reposition)
```
    Sets the reposition mode of this data-relation object. Use true to set the relation mode to REPOSITION and false to set it to SELECTION. This is the setter of the REPOSITION attribute.
    
    Specified by:
    
    setReposition in interface DataRelationInterface
    
    Parameters:
    
    reposition - the new reposition mode as described above.
  - setReposition
```
public void setReposition(boolean reposition)
```
    Sets the reposition mode of this data-relation object. Use true to set the relation mode to REPOSITION and false to set it to SELECTION. This is the setter of the REPOSITION attribute.
    
    Specified by:
    
    setReposition in interface DataRelationInterface
    
    Parameters:
    
    reposition - the new reposition mode as described above.
  - getParentFieldsAfter
```
public character getParentFieldsAfter()
```
    Obtain a comma-separated list of fields from the parent record in the relation to be written to XML after all nested child records.
    
    Specified by:
    
    getParentFieldsAfter in interface DataRelationInterface
    
    Returns:
    
    a comma-separated list of fields from the parent record in the relation to be written to XML after all nested child records.
  - getParentFieldsBefore
```
public character getParentFieldsBefore()
```
    Obtain a comma-separated list of fields from the parent record in the relation to be written to XML before any nested child records.
    
    Specified by:
    
    getParentFieldsBefore in interface DataRelationInterface
    
    Returns:
    
    a comma-separated list of fields from the parent record in the relation to be written to XML after all nested child records.
  - getParentBuffer
```
public handle getParentBuffer()
```
    Obtain the buffer handle of the parent member. This is the FWD implementation of PARENT-BUFFER ABL read-only attribute
    
    Specified by:
    
    getParentBuffer in interface DataRelationInterface
    
    Returns:
    
    the buffer handle of the parent member.
  - getParentBufferNative
```
public BufferImpl getParentBufferNative()
```
    Obtain the buffer of the parent member. This is the FWD implementation of PARENT-BUFFER ABL read-only attribute
    
    Returns:
    
    the buffer of the parent member.
  - getParentTable
```
public java.lang.String getParentTable()
```
    Obtain the name of the parent table.
    
    Returns:
    
    the name of the parent table.
  - isNested
```
public logical isNested()
```
    Checks whether child rows of a DataSet temp-table buffer are nested within their parent rows when writing the XML representation of DataSet object that contains data-relations.
    
    Specified by:
    
    isNested in interface DataRelationInterface
    
    Returns:
    
    yes if the child rows are nested within their parent rows.
  - setNested
```
public void setNested(boolean nested)
```
    Configures whether child rows of a DataSet temp-table buffer are nested within their parent rows when writing the XML representation of DataSet object that contains data-relations.
    
    Specified by:
    
    setNested in interface DataRelationInterface
    
    Parameters:
    
    nested - The new value of the NESTED attribute.
  - setNested
```
public void setNested(logical nested)
```
    Configures whether child rows of a DataSet temp-table buffer are nested within their parent rows when writing the XML representation of DataSet object that contains data-relations.
    
    Specified by:
    
    setNested in interface DataRelationInterface
    
    Parameters:
    
    nested - The new value of the NESTED attribute.
  - isRecursive
```
public logical isRecursive()
```
    Checks whether this data-relation is recursive.
    
    Specified by:
    
    isRecursive in interface DataRelationInterface
    
    Returns:
    
    yes when this data-relation is recursive.
  - _isRecursive
```
public boolean _isRecursive()
```
    Checks whether this data-relation is recursive.
    
    Returns:
    
    true when this data-relation is recursive.
  - isParentIdRelation
```
public logical isParentIdRelation()
```
    Checks whether the relationship between parent and child records is based on the RECID type of the parent record. In a PARENT-ID-RELATION, the value of RELATION-FIELDS attribute will be the name of the child buffer’s RECID field.
    
    Specified by:
    
    isParentIdRelation in interface DataRelationInterface
    
    Returns:
    
    YES if this is a PARENT-ID-RELATION
  - getQueryAsHandle
```
public handle getQueryAsHandle()
```
    Get the query associated with this relation.
    
    Specified by:
    
    getQueryAsHandle in interface QueryAssociable
    
    Returns:
    
    The associated query or unknown if none exists.
  - getQuery
```
public QueryWrapper getQuery()
```
    Get the query associated with this relation.
    
    Returns:
    
    The associated query or null if none exists.
  - setQueryAsHandle
```
public void setQueryAsHandle(handle qry)
```
    Set the query associated with the given resource.
    
    Specified by:
    
    setQueryAsHandle in interface QueryAssociable
    
    Parameters:
    
    qry - The query to associate.
  - setQueryAsHandle
```
public void setQueryAsHandle(QueryWrapper qry)
```
    Set the query associated with the given resource.
    
    Specified by:
    
    setQueryAsHandle in interface QueryAssociable
    
    Parameters:
    
    qry - The query to associate.
  - getADMData
```
public character getADMData()
```
    Get the value of the ADM-DATA attribute.
    
    Specified by:
    
    getADMData in interface ADMData
    
    Returns:
    
    See above.
  - setADMData
```
public void setADMData(java.lang.String value)
```
    Set the value of the ADM-DATA attribute.
    
    Specified by:
    
    setADMData in interface ADMData
    
    Parameters:
    
    value - The new value.
  - setADMData
```
public void setADMData(character value)
```
    Set the value of the ADM-DATA attribute.
    
    Specified by:
    
    setADMData in interface ADMData
    
    Parameters:
    
    value - The new value.
  - name
```
public character name()
```
    Get the name attribute of this object.
    
    Specified by:
    
    name in interface Nameable
    
    Returns:
    
    See above.
  - name
```
public void name(java.lang.String name)
```
    Set the name attribute of this object.
    
    Specified by:
    
    name in interface Nameable
    
    Parameters:
    
    name - The name to be set.
  - name
```
public void name(character name)
```
    Set the name attribute of this object.
    
    Specified by:
    
    name in interface Nameable
    
    Parameters:
    
    name - The name to be set.
  - valid
```
public boolean valid()
```
    Reports if this object is valid for use.
    
    Specified by:
    
    valid in interface WrappedResource
    
    Returns:
    
    true if we are valid (can be used).
  - getNextSibling
```
public handle getNextSibling()
```
    Get the NEXT-SIBLING attribute of this handle.
    
    Specified by:
    
    getNextSibling in interface CommonHandleChain
    
    Returns:
    
    See above.
  - getPrevSibling
```
public handle getPrevSibling()
```
    Get the PREV-SIBLING attribute of this handle.
    
    Specified by:
    
    getPrevSibling in interface CommonHandleChain
    
    Returns:
    
    See above.
  - getPrivateData
```
public character getPrivateData()
```
    Get the PRIVATE-DATA attribute of this handle.
    
    Specified by:
    
    getPrivateData in interface CommonHandleChain
    
    Returns:
    
    See above.
  - setPrivateData
```
public void setPrivateData(character data)
```
    Set the PRIVATE-DATA attribute of this handle.
    
    Specified by:
    
    setPrivateData in interface CommonHandleChain
    
    Parameters:
    
    data - The new private-data value.
  - setPrivateData
```
public void setPrivateData(java.lang.String data)
```
    Set the PRIVATE-DATA attribute of this handle.
    
    Specified by:
    
    setPrivateData in interface CommonHandleChain
    
    Parameters:
    
    data - The new private-data value.
  - _dynamic
```
public boolean _dynamic()
```
    Returns true if the buffer is dynamic.
    This is not emitted by conversion, is used internally by FWD.
    
    Specified by:
    
    _dynamic in interface DynamicResource
    
    Returns:
    
    true if the resource is dynamic, false otherwise.
  - getRelationFields
```
public java.lang.String[] getRelationFields(boolean parent)
```
    Extracts the list of relation fields for only one of the tables, in form of an array. If this is a PARENT-ID relation only the parent link is returned.
    
    Parameters:
    
    parent - Pass true for fields from parent table and false for fields from child table.
    
    Returns:
    
    the list of relation fields.
  - hasNameConstraints
```
protected boolean hasNameConstraints()
```
    Allows each resource to declare whether it has some naming constraints.
    
    Returns:
    
    This method always returns false, requiring that its name should be validated before assignment.
    
    See Also:
    
    HandleChain.validateName(java.lang.String)
  - resourceDelete
```
protected boolean resourceDelete()
```
    Worker to be implemented by each resource. Called by HandleResource.delete().
    
    Overrides:
    
    resourceDelete in class HandleResource
    
    Returns:
    
    Always true.
  - getRelationFieldArray
```
public java.lang.String[] getRelationFieldArray()
```
    The original set of field pairs. Only used for duplication of relations.
    
    Returns:
    
    original set of field pairs, if any.
  - _getRelationFields
```
java.lang.String _getRelationFields()
```
    Extract the list of relation fields. If this is a PARENT-ID relation only the parent link is returned, otherwise the set of pairs that defines the RELATION-FIELDS attribute is returned.
    
    Returns:
    
    the list of relation fields.
  - _isActive
```
boolean _isActive()
```
    Checks whether this relation is active.
    
    Returns:
    
    the current state of ACTIVE attribute.
  - _isReposition
```
boolean _isReposition()
```
    Query the current value of REPOSITION attribute.
    
    Returns:
    
    the current value of REPOSITION attribute.
  - _isParentIdRelation
```
private boolean _isParentIdRelation()
```
    Internal check whether this is a parent-id-relation.
    
    Returns:
    
    true when parentLink is not null.
  - createQuery
```
private boolean createQuery(java.lang.String where)
```
    Modifies the current WHERE expression that links the child table to its parent. This is the setter implementation for WHERE-STRING ABL attribute.
    
    Parameters:
    
    where - The new predicate.
    
    Returns:
    
    true if operation is successful.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object.
    
    Overrides:
    
    toString in class HandleResource
    
    Returns:
    
    a string representation of this object.

Class DataRelation

Field Summary

Fields inherited from class com.goldencode.p2j.util.HandleResource

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.util.HandleResource

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

Methods inherited from interface com.goldencode.p2j.util.DynamicResource

Methods inherited from interface com.goldencode.util.Printable

Methods inherited from interface com.goldencode.p2j.util.Deletable

Field Detail

dataSet

parentBuffer

childBuffer

recursive

relationFields

afterFields

beforeFields

parentLink

active

nested

reposition

fkHidden

maximumLevel

whereString

privateData

admData

name

isValid

query

refCount

Constructor Detail

DataRelation

DataRelation

Method Detail

confirmDynamic

isActive

setActive

setActive

getChildBuffer

getChildBufferNative

getChildTable

getCurrentQuery

getCurrentQuery

getCurrentQuery

getRelationFields

getWhereString

setWhereString

setWhereString

getForeignKeyHidden

setForeignKeyHidden

setForeignKeyHidden

getMaximumLevel

setMaximumLevel

setMaximumLevel

getReposition

setReposition

setReposition

getParentFieldsAfter

getParentFieldsBefore

getParentBuffer

getParentBufferNative

getParentTable

isNested

setNested

setNested

isRecursive

_isRecursive

isParentIdRelation

getQueryAsHandle

getQuery

setQueryAsHandle

setQueryAsHandle

getADMData

setADMData

setADMData

name

name