io.neba.api.annotations

Annotation Type ResourceModel

@Target(value={TYPE,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
public @interface ResourceModel

A resource model represents sling resources with specific sling resource types, JCR primary node types or mixin types.

Registering resource models

Classes annotated with @ResourceModel are automatically detected by NEBA when their containing packages are specified in the Neba-packages bundle manifest header, e.g.

 <Neba-Packages>
 com.acme.app.models,
 com.acme.app.more.models
 </Neba-Packages>
 

When using NEBA with Spring, models can be declared as Spring beans. In this case, NEBA will automatically detect all beans annotated with ResourceModel in the application context. Spring beans representing resource models must be prototypically scoped as they represent dynamically created, contextual pieces of data, not singletons.

Obtaining model instances

Resources with suitable types can be adapted to the corresponding models. This adaptation can also be done automatically using /apps/neba/neba.js with HTL, DefineObjectsTag with JSP or the ResourceModelResolver service.

Mapping resource properties to models

The fields of a @ResourceModel are automatically mapped from the properties of the resource it represents, unless they are static, final, injected (annotated with @Inject, @Autowired or @Resource) or annotated with @Unmapped. See also @Path, @This and @Reference and refer to the NEBA user guide.

Examples

    // A resource model for a sling resource type.
    @ResourceModel(types = "shared/components/teaser")
    public class MyTeaser {
       ...
    }

    // A resource model for a JCR node type.
    @ResourceModel(types = "nt:base")
    public class MyBaseModel {
       ...
    }

    // A resource model for a JCR mixin node type.
    @ResourceModel(types = "mix:versionable")
    public class MyVersionableModel {
       ...
    }
 

A ResourceModel applies to the type hierarchy of a resource. Therefore, if a Resource has no specific ResourceModel, i.e. no mapping to its Resource.getResourceType() or node type, its sling:resourceType hierarchy, followed by its JCR node type hierarchy (including mixin node types) are searched for a less specific model.

Since:

1.0.0

Author:

Olaf Otto

See Also:

Adaptable.adaptTo(Class)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value A resource type or JCR node type (including mixin types) are acceptable values for the type mapping.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name A user-defined name for the model.
String[]	types Deprecated. use value() instead. This method will be removed in future versions of neba.

Element Detail

value

public abstract String[] value

A resource type or JCR node type (including mixin types) are acceptable values for the type mapping. Example: "myapps/components/mycomponent", "nt:base", "mix:versionable".

types

@Deprecated
public abstract String[] types

Deprecated. use value() instead. This method will be removed in future versions of neba.

Default:

{}

name

public abstract String name

A user-defined name for the model. Views can lookup a model by name (see neba.js and ResourceModelResolver.resolveMostSpecificModelWithName(Resource, String)), thus, decoupling a view from the models type. If not given, the model name is automatically derived from the model's type name.

Default:

""