org.springframework.data.rest.core.mapping

Class MappingResourceMetadata

java.lang.Object

org.springframework.data.rest.core.mapping.MappingResourceMetadata

All Implemented Interfaces:

CollectionResourceMapping, ResourceMapping, ResourceMetadata

public class MappingResourceMetadata
extends Object
implements ResourceMetadata

ResourceMetadata based on a PersistentEntity.

Since:

2.1

Author:

Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
MappingResourceMetadata(PersistentEntity<?,?> entity) Creates a new MappingResourceMetadata for the given PersistentEntity.

Method Summary

Modifier and Type	Method and Description
protected String	getDefaultPathFor(Class<?> type) Returns the default path to be used if the path is not configured manually.
ResourceDescription	getDescription() Returns the resource's description.
Class<?>	getDomainType() Returns the domain type that is exposed through the resource.
Class<?>	getExcerptProjection() Returns the projection type to be used when embedding item resources into collections and related resources.
ResourceDescription	getItemResourceDescription() Returns the ResourceDescription for the item resource.
String	getItemResourceRel() Returns the relation type pointing to the item resource within a collection.
ResourceMapping	getMappingFor(PersistentProperty<?> property) Returns the ResourceMapping for the given PersistentProperty or null if not managed.
Path	getPath() Returns the path the resource is exposed under.
String	getRel() Returns the relation for the resource exported.
SearchResourceMappings	getSearchResourceMappings() Returns the SearchResourceMappings, i.e. the mappings for the search resource exposed for the current resource.
boolean	isExported() Returns whether the component shall be exported at all.
boolean	isExported(PersistentProperty<?> property) Returns whether the given PersistentProperty is a managed resource and in fact exported.
boolean	isManagedResource(PersistentProperty<?> property) Returns whether the type of the given PersistentProperty is exposed as resource itself.
boolean	isPagingResource() Returns whether the resource is paging one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.rest.core.mapping.CollectionResourceMapping

getExcerptProjection, getItemResourceDescription, getItemResourceRel

Methods inherited from interface org.springframework.data.rest.core.mapping.ResourceMapping

getDescription, getPath, getRel, isExported, isPagingResource

Constructor Detail

MappingResourceMetadata

public MappingResourceMetadata(PersistentEntity<?,?> entity)

Creates a new MappingResourceMetadata for the given PersistentEntity.

Parameters:

entity - must not be null.

Method Detail

getDomainType

public Class<?> getDomainType()

Description copied from interface: ResourceMetadata

Returns the domain type that is exposed through the resource.

Specified by:

getDomainType in interface ResourceMetadata

Returns:

isManagedResource

public boolean isManagedResource(PersistentProperty<?> property)

Description copied from interface: ResourceMetadata

Returns whether the type of the given PersistentProperty is exposed as resource itself.

Specified by:

isManagedResource in interface ResourceMetadata

Parameters:

property - must not be null.

Returns:

isExported

public boolean isExported(PersistentProperty<?> property)

Description copied from interface: ResourceMetadata

Returns whether the given PersistentProperty is a managed resource and in fact exported.

Specified by:

isExported in interface ResourceMetadata

Parameters:

property - must not be null.

Returns:

getMappingFor

public ResourceMapping getMappingFor(PersistentProperty<?> property)

Description copied from interface: ResourceMetadata

Returns the ResourceMapping for the given PersistentProperty or null if not managed.

Specified by:

getMappingFor in interface ResourceMetadata

Parameters:

property - must not be null.

Returns:

getSearchResourceMappings

public SearchResourceMappings getSearchResourceMappings()

Description copied from interface: ResourceMetadata

Returns the SearchResourceMappings, i.e. the mappings for the search resource exposed for the current resource.

Specified by:

getSearchResourceMappings in interface ResourceMetadata

Returns:

getPath

public Path getPath()

Description copied from interface: ResourceMapping

Returns the path the resource is exposed under.

Specified by:

getPath in interface ResourceMapping

Returns:

will never be null.

isExported

public boolean isExported()

Description copied from interface: ResourceMapping

Returns whether the component shall be exported at all.

Specified by:

isExported in interface ResourceMapping

Returns:

will never be null.

getRel

public String getRel()

Description copied from interface: ResourceMapping

Returns the relation for the resource exported.

Specified by:

getRel in interface ResourceMapping

Returns:

will never be null.

getItemResourceRel

public String getItemResourceRel()

Description copied from interface: CollectionResourceMapping

Returns the relation type pointing to the item resource within a collection.

Specified by:

getItemResourceRel in interface CollectionResourceMapping

Returns:

isPagingResource

public boolean isPagingResource()

Description copied from interface: ResourceMapping

Returns whether the resource is paging one.

Specified by:

isPagingResource in interface ResourceMapping

Returns:

getDescription

public ResourceDescription getDescription()

Description copied from interface: ResourceMapping

Returns the resource's description.

Specified by:

getDescription in interface ResourceMapping

Returns:

getItemResourceDescription

public ResourceDescription getItemResourceDescription()

Description copied from interface: CollectionResourceMapping

Returns the ResourceDescription for the item resource.

Specified by:

getItemResourceDescription in interface CollectionResourceMapping

Returns:

getExcerptProjection

public Class<?> getExcerptProjection()

Description copied from interface: CollectionResourceMapping

Returns the projection type to be used when embedding item resources into collections and related resources. If null is returned this will mean full rendering for collections and no rendering for related resources.

Specified by:

getExcerptProjection in interface CollectionResourceMapping

Returns:

getDefaultPathFor

protected String getDefaultPathFor(Class<?> type)

Returns the default path to be used if the path is not configured manually.

Parameters:

type - must not be null.

Returns: