org.springframework.roo.addon.layers.service.addon

Class ServiceMetadata

java.lang.Object

org.springframework.roo.metadata.AbstractMetadataItem

org.springframework.roo.classpath.itd.AbstractItdTypeDetailsProvidingMetadataItem

org.springframework.roo.addon.layers.service.addon.ServiceMetadata

All Implemented Interfaces:

org.springframework.roo.classpath.itd.ItdTypeDetailsProvidingMetadataItem, org.springframework.roo.classpath.itd.MemberHoldingTypeDetailsMetadataItem<org.springframework.roo.classpath.details.ItdTypeDetails>, org.springframework.roo.metadata.MetadataItem

public class ServiceMetadata
extends org.springframework.roo.classpath.itd.AbstractItdTypeDetailsProvidingMetadataItem

Metadata for RooService.

Since:

2.0

Author:

Juan Carlos García

Field Summary

Fields inherited from class org.springframework.roo.classpath.itd.AbstractItdTypeDetailsProvidingMetadataItem

aspectName, builder, destination, governorPhysicalTypeMetadata, governorTypeDetails, itdTypeDetails

Fields inherited from class org.springframework.roo.metadata.AbstractMetadataItem

valid

Constructor Summary

Constructors

Constructor and Description

ServiceMetadata(String identifier, org.springframework.roo.model.JavaType aspectName, org.springframework.roo.classpath.PhysicalTypeMetadata governorPhysicalTypeMetadata, org.springframework.roo.model.JavaType entity, org.springframework.roo.model.JavaType identifierType, boolean readOnly, List<org.springframework.roo.addon.finder.addon.parser.FinderMethod> finders, org.springframework.roo.classpath.details.MethodMetadata findAllGlobalSearchMethod, Map<org.springframework.roo.model.JavaType,org.springframework.roo.classpath.details.MethodMetadata> referencedFieldsFindAllMethods, Map<org.springframework.roo.model.JavaType,org.springframework.roo.classpath.details.MethodMetadata> countByReferencedFieldsMethods) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static String	createIdentifier(org.springframework.roo.model.JavaType javaType, org.springframework.roo.project.LogicalPath path)
List<org.springframework.roo.classpath.details.MethodMetadata>	getAllDefinedMethods() This method returns all defined methods in service interface
Map<org.springframework.roo.model.JavaType,org.springframework.roo.classpath.details.MethodMetadata>	getCountByReferenceFieldDefinedMethod() This method returns all defined count methods in service interface
org.springframework.roo.classpath.details.MethodMetadata	getCountMethod() Method that generates method "count".
org.springframework.roo.classpath.details.MethodMetadata	getDeleteBatchMethod() Method that generates "delete" batch method
org.springframework.roo.classpath.details.MethodMetadata	getDeleteMethod() Method that generates "delete" method.
org.springframework.roo.classpath.details.MethodMetadata	getFindAllGlobalSearchMethod() Method that generates method "findAll" method.
org.springframework.roo.classpath.details.MethodMetadata	getFindAllIterableMethod() Method that generates method "findAll" with iterable parameter.
org.springframework.roo.classpath.details.MethodMetadata	getFindAllMethod() Method that generates method "findAll" method.
List<org.springframework.roo.addon.finder.addon.parser.FinderMethod>	getFinders() Method that returns the finder methos.
org.springframework.roo.classpath.details.MethodMetadata	getFindOneMethod() Method that generates method "findOne".
static org.springframework.roo.model.JavaType	getJavaType(String metadataIdentificationString)
static String	getMetadataIdentiferType()
static org.springframework.roo.project.LogicalPath	getPath(String metadataIdentificationString)
Map<org.springframework.roo.model.JavaType,org.springframework.roo.classpath.details.MethodMetadata>	getReferencedFieldsFindAllDefinedMethods() This method returns all defined findAll methods for referenced fields in service interface
org.springframework.roo.classpath.details.MethodMetadata	getSaveBatchMethod() Method that generates "save" batch method.
org.springframework.roo.classpath.details.MethodMetadata	getSaveMethod() Method that generates "save" method.
static boolean	isValid(String metadataIdentificationString)
String	toString()

Methods inherited from class org.springframework.roo.classpath.itd.AbstractItdTypeDetailsProvidingMetadataItem

buildItd, ensureGovernorExtends, ensureGovernorHasConstructor, ensureGovernorHasField, ensureGovernorHasMethod, ensureGovernorImplements, ensureGovernorIsAnnotated, getAccessorMethod, getAccessorMethod, getAccessorMethod, getAccessorMethod, getAspectName, getField, getField, getGovernorMethod, getGovernorMethod, getMemberHoldingTypeDetails, getMethod, getMutatorMethod, getMutatorMethod, getTypeAnnotation, governorHasMethod, governorHasMethod, governorHasMethodWithSameName, hashCode, isImplementing

Methods inherited from class org.springframework.roo.metadata.AbstractMetadataItem

getId, isValid

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.roo.metadata.MetadataItem

getId, isValid

Constructor Detail

ServiceMetadata

public ServiceMetadata(String identifier,
               org.springframework.roo.model.JavaType aspectName,
               org.springframework.roo.classpath.PhysicalTypeMetadata governorPhysicalTypeMetadata,
               org.springframework.roo.model.JavaType entity,
               org.springframework.roo.model.JavaType identifierType,
               boolean readOnly,
               List<org.springframework.roo.addon.finder.addon.parser.FinderMethod> finders,
               org.springframework.roo.classpath.details.MethodMetadata findAllGlobalSearchMethod,
               Map<org.springframework.roo.model.JavaType,org.springframework.roo.classpath.details.MethodMetadata> referencedFieldsFindAllMethods,
               Map<org.springframework.roo.model.JavaType,org.springframework.roo.classpath.details.MethodMetadata> countByReferencedFieldsMethods)

Constructor

Parameters:

identifier - the identifier for this item of metadata (required)

aspectName - the Java type of the ITD (required)

governorPhysicalTypeMetadata - the governor, which is expected to contain a ClassOrInterfaceTypeDetails (required)

entity - entity referenced on interface

identifierType - the type of the entity's identifier field (required)

readOnly - specifies if current entity is defined as readOnly or not

finders - list of finders added to current entity

findAllGlobalSearchMethod - MethodMetadata with findAllGlobalSearch method

referencedFieldsFindAllMethods -

countByReferencedFieldsMethods -

Method Detail

createIdentifier

public static String createIdentifier(org.springframework.roo.model.JavaType javaType,
                      org.springframework.roo.project.LogicalPath path)

getJavaType

public static org.springframework.roo.model.JavaType getJavaType(String metadataIdentificationString)

getMetadataIdentiferType

public static String getMetadataIdentiferType()

getPath

public static org.springframework.roo.project.LogicalPath getPath(String metadataIdentificationString)

isValid

public static boolean isValid(String metadataIdentificationString)

getFindAllGlobalSearchMethod

public org.springframework.roo.classpath.details.MethodMetadata getFindAllGlobalSearchMethod()

Method that generates method "findAll" method. This method includes GlobalSearch parameters to be able to filter results.

Returns:

MethodMetadata

getFindAllMethod

public org.springframework.roo.classpath.details.MethodMetadata getFindAllMethod()

Method that generates method "findAll" method.

Returns:

MethodMetadataBuilder with public List findAll(); structure

getFindAllIterableMethod

public org.springframework.roo.classpath.details.MethodMetadata getFindAllIterableMethod()

Method that generates method "findAll" with iterable parameter.

Returns:

MethodMetadataBuilder with public List findAll(Iterable ids) structure

getFindOneMethod

public org.springframework.roo.classpath.details.MethodMetadata getFindOneMethod()

Method that generates method "findOne".

Returns:

MethodMetadataBuilder with public Entity findOne(Long id); structure

getCountMethod

public org.springframework.roo.classpath.details.MethodMetadata getCountMethod()

Method that generates method "count".

Returns:

MethodMetadataBuilder with public long count(); structure

getSaveMethod

public org.springframework.roo.classpath.details.MethodMetadata getSaveMethod()

Method that generates "save" method.

Returns:

MethodMetadataBuilder with public Entity save(Entity entity); structure

getDeleteMethod

public org.springframework.roo.classpath.details.MethodMetadata getDeleteMethod()

Method that generates "delete" method.

Returns:

MethodMetadataBuilder with public void delete(Long id); structure

getSaveBatchMethod

public org.springframework.roo.classpath.details.MethodMetadata getSaveBatchMethod()

Method that generates "save" batch method.

Returns:

MethodMetadataBuilder with public List save(Iterable entities); structure

getDeleteBatchMethod

public org.springframework.roo.classpath.details.MethodMetadata getDeleteBatchMethod()

Method that generates "delete" batch method

Returns:

MethodMetadataBuilder with public void delete(Iterable ids); structure

getAllDefinedMethods

public List<org.springframework.roo.classpath.details.MethodMetadata> getAllDefinedMethods()

This method returns all defined methods in service interface

Returns:

getCountByReferenceFieldDefinedMethod

public Map<org.springframework.roo.model.JavaType,org.springframework.roo.classpath.details.MethodMetadata> getCountByReferenceFieldDefinedMethod()

This method returns all defined count methods in service interface

Returns:

getReferencedFieldsFindAllDefinedMethods

public Map<org.springframework.roo.model.JavaType,org.springframework.roo.classpath.details.MethodMetadata> getReferencedFieldsFindAllDefinedMethods()

This method returns all defined findAll methods for referenced fields in service interface

Returns:

toString

public String toString()

Overrides:

toString in class org.springframework.roo.classpath.itd.AbstractItdTypeDetailsProvidingMetadataItem

getFinders

public List<org.springframework.roo.addon.finder.addon.parser.FinderMethod> getFinders()

Method that returns the finder methos.

Returns:

a list of finder methods