org.springframework.roo.addon.web.mvc.controller.addon.details

Interface WebMetadataService

All Known Implementing Classes:

WebMetadataServiceImpl

public interface WebMetadataService

Service to retrieve various metadata information for use by Web scaffolding add-ons.

Since:

1.1.2

Author:

Stefan Schmidt

Method Summary

Methods

Modifier and Type	Method and Description
Map<org.springframework.roo.classpath.customdata.tagkeys.MethodMetadataCustomDataKey,org.springframework.roo.classpath.layers.MemberTypeAdditions>	getCrudAdditions(org.springframework.roo.model.JavaType domainType, String metadataIdentificationString)
Map<org.springframework.roo.model.JavaSymbolName,DateTimeFormatDetails>	getDatePatterns(org.springframework.roo.model.JavaType javaType, org.springframework.roo.classpath.scanner.MemberDetails memberDetails, String metadataIdentificationString)
List<JavaTypeMetadataDetails>	getDependentApplicationTypeMetadata(org.springframework.roo.model.JavaType javaType, org.springframework.roo.classpath.scanner.MemberDetails memberDetails, String metadataIdentificationString)
Set<FinderMetadataDetails>	getDynamicFinderMethodsAndFields(org.springframework.roo.model.JavaType formBackingType, org.springframework.roo.classpath.scanner.MemberDetails formBackingTypeDetails, String consumingMetadataId) Returns details of the dynamic finders for the given form backing type
org.springframework.roo.classpath.details.FieldMetadata	getIdentifierField(org.springframework.roo.model.JavaType javaType)
JavaTypeMetadataDetails	getJavaTypeMetadataDetails(org.springframework.roo.model.JavaType javaType, org.springframework.roo.classpath.scanner.MemberDetails memberDetails, String metadataIdentificationString)
JavaTypePersistenceMetadataDetails	getJavaTypePersistenceMetadataDetails(org.springframework.roo.model.JavaType javaType, org.springframework.roo.classpath.scanner.MemberDetails memberDetails, String metadataIdentificationString)
org.springframework.roo.classpath.scanner.MemberDetails	getMemberDetails(org.springframework.roo.model.JavaType javaType)
SortedMap<org.springframework.roo.model.JavaType,JavaTypeMetadataDetails>	getRelatedApplicationTypeMetadata(org.springframework.roo.model.JavaType baseType, org.springframework.roo.classpath.scanner.MemberDetails baseTypeDetails, String metadataId) Returns details of the Java types that are related to the given type
List<org.springframework.roo.classpath.details.FieldMetadata>	getScaffoldEligibleFieldMetadata(org.springframework.roo.model.JavaType javaType, org.springframework.roo.classpath.scanner.MemberDetails memberDetails, String metadataIdentificationString)
boolean	isApplicationType(org.springframework.roo.model.JavaType javaType) Deprecated. use TypeLocationService.isInProject(JavaType) instead
boolean	isRooIdentifier(org.springframework.roo.model.JavaType javaType, org.springframework.roo.classpath.scanner.MemberDetails memberDetails)

Method Detail

getCrudAdditions

Map<org.springframework.roo.classpath.customdata.tagkeys.MethodMetadataCustomDataKey,org.springframework.roo.classpath.layers.MemberTypeAdditions> getCrudAdditions(org.springframework.roo.model.JavaType domainType,
                                                                                                                                                                  String metadataIdentificationString)

getDatePatterns

Map<org.springframework.roo.model.JavaSymbolName,DateTimeFormatDetails> getDatePatterns(org.springframework.roo.model.JavaType javaType,
                                                                                      org.springframework.roo.classpath.scanner.MemberDetails memberDetails,
                                                                                      String metadataIdentificationString)

getDependentApplicationTypeMetadata

List<JavaTypeMetadataDetails> getDependentApplicationTypeMetadata(org.springframework.roo.model.JavaType javaType,
                                                                org.springframework.roo.classpath.scanner.MemberDetails memberDetails,
                                                                String metadataIdentificationString)

getDynamicFinderMethodsAndFields

Set<FinderMetadataDetails> getDynamicFinderMethodsAndFields(org.springframework.roo.model.JavaType formBackingType,
                                                          org.springframework.roo.classpath.scanner.MemberDetails formBackingTypeDetails,
                                                          String consumingMetadataId)

Returns details of the dynamic finders for the given form backing type

Parameters:

formBackingType -

formBackingTypeDetails -

consumingMetadataId - the ID of the MetadataItem that's using these details

Returns:

null if this information is not currently available

getIdentifierField

org.springframework.roo.classpath.details.FieldMetadata getIdentifierField(org.springframework.roo.model.JavaType javaType)

getJavaTypeMetadataDetails

JavaTypeMetadataDetails getJavaTypeMetadataDetails(org.springframework.roo.model.JavaType javaType,
                                                 org.springframework.roo.classpath.scanner.MemberDetails memberDetails,
                                                 String metadataIdentificationString)

getJavaTypePersistenceMetadataDetails

JavaTypePersistenceMetadataDetails getJavaTypePersistenceMetadataDetails(org.springframework.roo.model.JavaType javaType,
                                                                       org.springframework.roo.classpath.scanner.MemberDetails memberDetails,
                                                                       String metadataIdentificationString)

getMemberDetails

org.springframework.roo.classpath.scanner.MemberDetails getMemberDetails(org.springframework.roo.model.JavaType javaType)

getRelatedApplicationTypeMetadata

SortedMap<org.springframework.roo.model.JavaType,JavaTypeMetadataDetails> getRelatedApplicationTypeMetadata(org.springframework.roo.model.JavaType baseType,
                                                                                                          org.springframework.roo.classpath.scanner.MemberDetails baseTypeDetails,
                                                                                                          String metadataId)

Returns details of the Java types that are related to the given type

Parameters:

baseType - the type for which to obtain related types

baseTypeDetails - the details of the given type

metadataId - the ID of the MetadataItem consuming the returned details; required for registering the necessary metadata dependencies

Returns:

a non-null map that includes the given type

getScaffoldEligibleFieldMetadata

List<org.springframework.roo.classpath.details.FieldMetadata> getScaffoldEligibleFieldMetadata(org.springframework.roo.model.JavaType javaType,
                                                                                             org.springframework.roo.classpath.scanner.MemberDetails memberDetails,
                                                                                             String metadataIdentificationString)

isApplicationType

@Deprecated
boolean isApplicationType(org.springframework.roo.model.JavaType javaType)

Deprecated. use TypeLocationService.isInProject(JavaType) instead

isRooIdentifier

boolean isRooIdentifier(org.springframework.roo.model.JavaType javaType,
                      org.springframework.roo.classpath.scanner.MemberDetails memberDetails)