org.springframework.data.rest.core.mapping

Interface ResourceMetadata

All Superinterfaces:

CollectionResourceMapping, ResourceMapping

All Known Implementing Classes:

MappingResourceMetadata

public interface ResourceMetadata
extends CollectionResourceMapping

Interface for metadata of resources exposed throught the system.

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method and Description
Class<?>	getDomainType() Returns the domain type that is exposed through the resource.
ResourceMapping	getMappingFor(PersistentProperty<?> property) Returns the ResourceMapping for the given PersistentProperty or null if not managed.
SearchResourceMappings	getSearchResourceMappings() Returns the SearchResourceMappings, i.e. the mappings for the search resource exposed for the current resource.
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.

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

Method Detail

getDomainType

Class<?> getDomainType()

Returns the domain type that is exposed through the resource.

Returns:

isManagedResource

boolean isManagedResource(PersistentProperty<?> property)

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

Parameters:

property - must not be null.

Returns:

isExported

boolean isExported(PersistentProperty<?> property)

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

Parameters:

property - must not be null.

Returns:

getMappingFor

ResourceMapping getMappingFor(PersistentProperty<?> property)

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

Parameters:

property - must not be null.

Returns:

getSearchResourceMappings

SearchResourceMappings getSearchResourceMappings()

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

Returns: