org.datanucleus.state.RelationshipManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of datanucleus-core Show documentation
Show all versions of datanucleus-core Show documentation
DataNucleus Core provides the primary components of a heterogenous Java persistence solution.
It supports persistence API's being layered on top of the core functionality.
/**********************************************************************
Copyright (c) 2011 Andy Jefferson and others. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Contributors:
...
**********************************************************************/
package org.datanucleus.state;
/**
* Manager for (bidirectional) relationships of an object (StateManager).
* Designed as a stand-alone process to run just before flush.
* Updates on bidirectional relations are registered during the persistence process.
* Call to checkConsistency() will check for consistency and throw exceptions as appropriate.
* Call to process() will perform updates at the other side of the registered relations so all is consistent.
*
* TODO Cater for Map put/remove calls
* TODO Consider sharing info with org.datanucleus.flush.OperationQueue which holds similar information (but only when optimistic)
*/
public interface RelationshipManager
{
/**
* Convenience method to clear all fields from being managed.
*/
void clearFields();
/**
* Method that is called when the user calls setXXX() on a field.
* @param fieldNumber Number of the field
* @param oldValue The old value
* @param newValue The new value
*/
void relationChange(int fieldNumber, Object oldValue, Object newValue);
/**
* Method to register a change in the contents of a container field, with an object being added.
* @param fieldNumber Number of the field
* @param val Value being added
*/
void relationAdd(int fieldNumber, Object val);
/**
* Method to register a change in the contents of a container field, with an object being removed.
* @param fieldNumber Number of the field
* @param val Value being removed
*/
void relationRemove(int fieldNumber, Object val);
/**
* Accessor for whether a field is being managed.
* @param fieldNumber Number of the field
* @return Whether it is currently managed
*/
boolean managesField(int fieldNumber);
/**
* Method to check for consistency the managed relations of this object with the related objects.
*/
void checkConsistency();
/**
* Method to process the (bidirectional) relations for this object.
*/
void process();
}