org.apache.polygene.api

Interface PolygeneAPI

All Known Subinterfaces:

PolygeneSPI

public interface PolygeneAPI

Encapsulation of the Polygene API.

Field Summary

Fields

Modifier and Type	Field and Description
static Function<Composite,CompositeInstance>	FUNCTION_COMPOSITE_INSTANCE_OF Function that returns the CompositeInstance of a Composite.
static Function<Composite,CompositeDescriptor>	FUNCTION_DESCRIPTOR_FOR Function that returns the CompositeDescriptor of a Composite.

Method Summary

Modifier and Type	Method and Description
AssociationDescriptor	associationDescriptorFor(AbstractAssociation association) Returns the AssociationDescriptor of the Association.
CompositeDescriptor	compositeDescriptorFor(Object compositeOrServiceReference) Returns the CompositeDescriptor of the Composite or ServiceReference.
<T> T	dereference(T composite) If a Modifier gets a reference to the Composite using @This, then that reference must be dereferenced using this method before handing it out for others to use.
EntityDescriptor	entityDescriptorFor(Object entity) Returns the EntityDescriptor of the EntityComposite.
boolean	isComposite(Object object) Tests if the given object is a Composite
ModelDescriptor	modelDescriptorFor(Object compositeOrServiceReference) Returns the ModelDescriptor of the Composite or ServiceReference.
ModuleDescriptor	moduleOf(Object compositeOrServiceReferenceOrUow) Returns the Module where the Composite, ServiceReference or UnitOfWork belongs.
PropertyDescriptor	propertyDescriptorFor(Property<?> property) Returns the PropertyDescriptor of the Property.
ServiceDescriptor	serviceDescriptorFor(Object service) Returns the ServiceDescriptor of the ServiceComposite.
TransientDescriptor	transientDescriptorFor(Object transsient) Returns the TransientDescriptor of the TransientComposite.
ValueDescriptor	valueDescriptorFor(Object value) Returns the ValueDescriptor of the ValueComposite.

Field Detail

FUNCTION_COMPOSITE_INSTANCE_OF

static final Function<Composite,CompositeInstance> FUNCTION_COMPOSITE_INSTANCE_OF

Function that returns the CompositeInstance of a Composite.

FUNCTION_DESCRIPTOR_FOR

static final Function<Composite,CompositeDescriptor> FUNCTION_DESCRIPTOR_FOR

Function that returns the CompositeDescriptor of a Composite.

Method Detail

dereference

<T> T dereference(T composite)

If a Modifier gets a reference to the Composite using @This, then that reference must be dereferenced using this method before handing it out for others to use.

Type Parameters:

T - Parameterized type of the Composite

Parameters:

composite - instance reference injected in Modified using @This

Returns:

the dereferenced Composite

moduleOf

ModuleDescriptor moduleOf(Object compositeOrServiceReferenceOrUow)

Returns the Module where the Composite, ServiceReference or UnitOfWork belongs.

Parameters:

compositeOrServiceReferenceOrUow - The Composite (Service, Value, Entity or Transient) or ServiceReference or UnitOfWork to lookup the Module it belongs to

Returns:

The Module instance where the Composite, ServiceReference or UnitOfWork belongs to

modelDescriptorFor

ModelDescriptor modelDescriptorFor(Object compositeOrServiceReference)

Returns the ModelDescriptor of the Composite or ServiceReference.

Parameters:

compositeOrServiceReference - The Composite (Service, Value, Entity or Transient) of ServiceReference for which to lookup the ModelDescriptor

Returns:

The ModelDescriptor of the Composite or ServiceReference

compositeDescriptorFor

CompositeDescriptor compositeDescriptorFor(Object compositeOrServiceReference)

Returns the CompositeDescriptor of the Composite or ServiceReference.

Parameters:

compositeOrServiceReference - The Composite (Service, Value, Entity or Transient) or ServiceReference for which to lookup the CompositeDescriptor

Returns:

The CompositeDescriptor of the Composite or ServiceReference

transientDescriptorFor

TransientDescriptor transientDescriptorFor(Object transsient)

Returns the TransientDescriptor of the TransientComposite.

Parameters:

transsient - The TransientComposite for which to lookup the TransientDescriptor

Returns:

The TransientDescriptor of the TransientComposite

entityDescriptorFor

EntityDescriptor entityDescriptorFor(Object entity)

Returns the EntityDescriptor of the EntityComposite.

Parameters:

entity - The EntityComposite for which to lookup the EntityDescriptor

Returns:

The EntityDescriptor of the EntityComposite

valueDescriptorFor

ValueDescriptor valueDescriptorFor(Object value)

Returns the ValueDescriptor of the ValueComposite.

Parameters:

value - The ValueComposite for which to lookup the ValueDescriptor

Returns:

The ValueDescriptor of the ValueComposite

serviceDescriptorFor

ServiceDescriptor serviceDescriptorFor(Object service)

Returns the ServiceDescriptor of the ServiceComposite.

Parameters:

service - The ServiceComposite for which to lookup the ServiceDescriptor

Returns:

The ServiceDescriptor of the ServiceComposite

propertyDescriptorFor

PropertyDescriptor propertyDescriptorFor(Property<?> property)

Returns the PropertyDescriptor of the Property.

Parameters:

property - The Property for which to lookup the PropertyDescriptor

Returns:

The PropertyDescriptor of the Property

associationDescriptorFor

AssociationDescriptor associationDescriptorFor(AbstractAssociation association)

Returns the AssociationDescriptor of the Association.

Parameters:

association - The Association for which to lookup the AssociationDescriptor

Returns:

The AssociationDescriptor of the Association

isComposite

boolean isComposite(Object object)

Tests if the given object is a Composite

Parameters:

object - The Java object to be checked

Returns:

true if the given object is a Composite type.