org.apache.isis.core.metamodel.spec

Interface ObjectSpecification

All Superinterfaces:

DefaultProvider, Dirtiable, FacetHolder, Hierarchical, IdentifiedHolder, ObjectActionContainer, ObjectAssociationContainer, Specification

All Known Implementing Classes:

ObjectSpecificationAbstract, ObjectSpecificationDefault, ObjectSpecificationForFreeStandingList

public interface ObjectSpecification
extends Specification, ObjectActionContainer, ObjectAssociationContainer, Hierarchical, Dirtiable, DefaultProvider

Represents an entity or value (cf Class) within the metamodel.

As specifications are cyclic (specifically a class will reference its subclasses, which in turn reference their superclass) they need be created first, and then later work out its internals. Hence we create ObjectSpecifications as we need them, and then introspect them later.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<ObjectSpecification>	COMPARATOR_FULLY_QUALIFIED_CLASS_NAME
static Comparator<ObjectSpecification>	COMPARATOR_SHORT_IDENTIFIER_IGNORE_CASE
static List<ObjectSpecification>	EMPTY_LIST
static com.google.common.base.Function<ObjectSpecification,String>	FUNCTION_FULLY_QUALIFIED_CLASS_NAME

Method Summary

Methods

Modifier and Type	Method and Description
Object	createObject()
ObjectTitleContext	createTitleInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter targetObjectAdapter) Create an InteractionContext representing an attempt to read the object's title.
ObjectValidityContext	createValidityInteractionContext(DeploymentCategory deploymentCategory, AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter targetObjectAdapter) Create an InteractionContext representing an attempt to save the object.
Class<?>	getCorrespondingClass()
String	getCssClass() Returns a css class name of the specification.
String	getDescription() Returns the description, if any, of the specification.
String	getFullIdentifier() Returns an (immutable) "full" identifier for this specification.
String	getHelp() Returns a help string or lookup reference, if any, of the specification.
String	getIconName(ObjectAdapter object) Returns the name of an icon to use for the specified object.
String	getPluralName() Returns the plural name for objects of this specification.
String	getShortIdentifier() Returns an (immutable) "short" identifier for this specification.
String	getSingularName() Returns the (singular) name for objects of this specification.
ObjectSpecId	getSpecId() Returns the (unique) spec Id, as per the ObjectSpecIdFacet.
String	getTitle(ObjectAdapter adapter, org.apache.isis.applib.profiles.Localization localization) Deprecated. use getTitle(ObjectAdapter, ObjectAdapter, Localization)
String	getTitle(ObjectAdapter contextAdapterIfAny, ObjectAdapter targetAdapter, org.apache.isis.applib.profiles.Localization localization) Returns the title to display of target adapter, rendered within the context of some other adapter (if any).
ObjectAdapter	initialize(ObjectAdapter object) REVIEW: should this behaviour move, eg onto ObjectAdapter?
boolean	isAbstract()
boolean	isEncodeable() Determines if objects of this type can be converted to a data-stream.
boolean	isHidden() Whether has the HiddenFacet
boolean	isImmutable() Whether has the ImmutableFacet.
boolean	isNotCollection() Determines if the object represents an value or object.
boolean	isParented() Determines if objects of this type are parented (a parented collection, or an aggregated entity).
boolean	isParentedOrFreeCollection() Determines if objects of this type are a parented (internal) or free-standing (external) collection.
boolean	isParseable() Determines if objects of this type can be set up from a text entry string.
boolean	isService() Whether or not this specification represents a domain service (as opposed to a domain entity or a value etc).
Consent	isValid(ObjectAdapter adapter) Determines whether the specified object is in a valid state (for example, so can be persisted); represented as a Consent.
InteractionResult	isValidResult(ObjectAdapter adapter) Determines whether the specified object is in a valid state (for example, so can be persisted); represented as a InteractionResult.
boolean	isValue() Determines if objects of this type are values.
boolean	isValueOrIsParented() Determines if objects of this type are either values or aggregated.
void	markAsService()
Persistability	persistability() Determines if objects of this specification can be persisted or not.

Methods inherited from interface org.apache.isis.core.metamodel.spec.Specification

getFeatureType, getInstance

Methods inherited from interface org.apache.isis.core.metamodel.facetapi.IdentifiedHolder

getIdentifier

Methods inherited from interface org.apache.isis.core.metamodel.facetapi.FacetHolder

addFacet, addFacet, containsDoOpFacet, containsFacet, getFacet, getFacets, getFacetTypes, removeFacet, removeFacet

Methods inherited from interface org.apache.isis.core.metamodel.spec.feature.ObjectActionContainer

getObjectAction, getObjectAction, getObjectAction, getObjectActions, getObjectActions, getObjectActions, getServiceActionsReturning

Methods inherited from interface org.apache.isis.core.metamodel.spec.feature.ObjectAssociationContainer

getAssociation, getAssociations, getAssociations, getAssociations, getCollections, getProperties

Methods inherited from interface org.apache.isis.core.metamodel.spec.Hierarchical

hasSubclasses, interfaces, isOfType, subclasses, superclass

Methods inherited from interface org.apache.isis.core.metamodel.spec.Dirtiable

clearDirty, isDirty, markDirty

Methods inherited from interface org.apache.isis.core.metamodel.spec.DefaultProvider

getDefaultValue

Field Detail

EMPTY_LIST

static final List<ObjectSpecification> EMPTY_LIST

FUNCTION_FULLY_QUALIFIED_CLASS_NAME

static final com.google.common.base.Function<ObjectSpecification,String> FUNCTION_FULLY_QUALIFIED_CLASS_NAME

COMPARATOR_FULLY_QUALIFIED_CLASS_NAME

static final Comparator<ObjectSpecification> COMPARATOR_FULLY_QUALIFIED_CLASS_NAME

COMPARATOR_SHORT_IDENTIFIER_IGNORE_CASE

static final Comparator<ObjectSpecification> COMPARATOR_SHORT_IDENTIFIER_IGNORE_CASE

Method Detail

getCorrespondingClass

Class<?> getCorrespondingClass()

Returns:

getSpecId

ObjectSpecId getSpecId()

Returns the (unique) spec Id, as per the ObjectSpecIdFacet.

This will typically be the value of the ObjectType annotation (or equivalent); if non has been specified then will default to the fully qualified class name (with class name substituted if necessary to allow for runtime bytecode enhancement.

The ObjectSpecification can be retrieved using SpecificationLoader.lookupBySpecId(ObjectSpecId).

getFullIdentifier

String getFullIdentifier()

Returns an (immutable) "full" identifier for this specification.

This will be the fully qualified name of the Class object that this object represents (i.e. it includes the package name).

getShortIdentifier

String getShortIdentifier()

Returns an (immutable) "short" identifier for this specification.

This will be the class name without the package; any text up to and including the last period is removed.

getSingularName

String getSingularName()

Returns the (singular) name for objects of this specification.

Corresponds to the SingleStringValueFacet.value() of NamedFacet; is not necessarily immutable.

getPluralName

String getPluralName()

Returns the plural name for objects of this specification.

Corresponds to the value of PluralFacet; is not necessarily immutable.

getDescription

String getDescription()

Returns the description, if any, of the specification.

Corresponds to the DescribedAsFacet#value()) value of DescribedAsFacet; is not necessarily immutable.

Specified by:

getDescription in interface Specification

See Also:

#getHelp()

getHelp

String getHelp()

Returns a help string or lookup reference, if any, of the specification.

Corresponds to the HelpFacet#value()) value of HelpFacet; is not necessarily immutable.

getCssClass

String getCssClass()

Returns a css class name of the specification.

Corresponds to the CssClass#value()) value of CssClassFacet;

getTitle

@Deprecated
String getTitle(ObjectAdapter adapter,
                         org.apache.isis.applib.profiles.Localization localization)

Deprecated. use getTitle(ObjectAdapter, ObjectAdapter, Localization)

Returns the title string for the specified object.

Corresponds to the TitleFacet#value()) value of TitleFacet; is not necessarily immutable.

getTitle

String getTitle(ObjectAdapter contextAdapterIfAny,
              ObjectAdapter targetAdapter,
              org.apache.isis.applib.profiles.Localization localization)

Returns the title to display of target adapter, rendered within the context of some other adapter (if any).

See Also:

TitleFacet.title(ObjectAdapter, ObjectAdapter, org.apache.isis.applib.profiles.Localization)

getIconName

String getIconName(ObjectAdapter object)

Returns the name of an icon to use for the specified object.

Corresponds to the IconFacet#iconName(ObjectAdapter)) icon name returned by the IconFacet; is not necessarily immutable.

isAbstract

boolean isAbstract()

createTitleInteractionContext

ObjectTitleContext createTitleInteractionContext(AuthenticationSession session,
                                               InteractionInvocationMethod invocationMethod,
                                               ObjectAdapter targetObjectAdapter)

Create an InteractionContext representing an attempt to read the object's title.

createValidityInteractionContext

ObjectValidityContext createValidityInteractionContext(DeploymentCategory deploymentCategory,
                                                     AuthenticationSession session,
                                                     InteractionInvocationMethod invocationMethod,
                                                     ObjectAdapter targetObjectAdapter)

Create an InteractionContext representing an attempt to save the object.

Parameters:

deploymentCategory - TODO

isValid

Consent isValid(ObjectAdapter adapter)

Determines whether the specified object is in a valid state (for example, so can be persisted); represented as a Consent.

isValidResult

InteractionResult isValidResult(ObjectAdapter adapter)

Determines whether the specified object is in a valid state (for example, so can be persisted); represented as a InteractionResult.

persistability

Persistability persistability()

Determines if objects of this specification can be persisted or not. If it can be persisted (i.e. it return something other than Persistability.TRANSIENT ObjectAdapter.isPersistent() will indicated whether the object is persistent or not. If they cannot be persisted then ObjectAdapter. persistability() should be ignored.

isNotCollection

boolean isNotCollection()

Determines if the object represents an value or object.

In effect, means that it doesn't have the CollectionFacet, and therefore will return NOT isParentedOrFreeCollection()

See Also:

#isCollection().

isParentedOrFreeCollection

boolean isParentedOrFreeCollection()

Determines if objects of this type are a parented (internal) or free-standing (external) collection.

In effect, means has got CollectionFacet, and therefore will return NOT isNotCollection().

See Also:

isNotCollection()

isValue

boolean isValue()

Determines if objects of this type are values.

In effect, means has got ValueFacet.

isParented

boolean isParented()

Determines if objects of this type are parented (a parented collection, or an aggregated entity).

In effect, means has got ParentedFacet.

isValueOrIsParented

boolean isValueOrIsParented()

Determines if objects of this type are either values or aggregated.

See Also:

isValue(), isParented()

isParseable

boolean isParseable()

Determines if objects of this type can be set up from a text entry string.

In effect, means has got a ParseableFacet.

isEncodeable

boolean isEncodeable()

Determines if objects of this type can be converted to a data-stream.

In effect, means has got EncodableFacet.

isImmutable

boolean isImmutable()

Whether has the ImmutableFacet.

isHidden

boolean isHidden()

Whether has the HiddenFacet

createObject

Object createObject()

initialize

ObjectAdapter initialize(ObjectAdapter object)

REVIEW: should this behaviour move, eg onto ObjectAdapter?

isService

boolean isService()

Whether or not this specification represents a domain service (as opposed to a domain entity or a value etc).

WARNING: this only returns true once the metamodel has been fully built, and a PersistenceSession has been opened. This should probably be improved upon; for now, beware...

markAsService

void markAsService()