JavaTypePersistenceMetadataDetails.java

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

import java.util.List;

import org.apache.commons.lang3.Validate;
import org.springframework.roo.classpath.details.FieldMetadata;
import org.springframework.roo.classpath.details.MethodMetadata;
import org.springframework.roo.classpath.layers.MemberTypeAdditions;
import org.springframework.roo.model.JavaType;

/**
 * Aggregates persistence metadata for a given {@link JavaType} which is needed
 * by Web scaffolding add-ons.
 * 
 * @author Stefan Schmidt
 * @since 1.1.2
 */
public class JavaTypePersistenceMetadataDetails {

    private final MemberTypeAdditions countMethod;
    private final MemberTypeAdditions findAllMethod;

    private final MemberTypeAdditions findEntriesMethod;
    private final List<String> finderNames;
    private final MemberTypeAdditions findMethod;
    private final MethodMetadata identifierAccessorMethod;
    private final FieldMetadata identifierField;
    private final JavaType identifierType;
    private final boolean isRooIdentifier;
    private final MemberTypeAdditions mergeMethod;
    private final MemberTypeAdditions persistMethod;

    private final MemberTypeAdditions removeMethod;

    private final List<FieldMetadata> rooIdentifierFields;
    private final MethodMetadata versionAccessorMethod;

    /**
     * Constructor for JavaTypePersistenceMetadataDetails
     * 
     * @param identifierType (must not be null)
     * @param identifierField (must not be null)
     * @param identifierAccessorMethod (must not be null)
     * @param versionAccessorMethod (may be null if no version accessor is
     *            present)
     * @param persistMethod (may be null if no persist method is present)
     * @param mergeMethod (may be null if no merge method is present)
     * @param removeMethod (may be null if no remove method is present)
     * @param findAllMethod (may be null if no findAll method is present)
     * @param findMethod (may be null if no find method is present)
     * @param countMethod (may be null if no count method is present)
     * @param finderNames (must not be null, but may be empty of no finders are
     *            defined)
     * @param isRooIdentifier
     * @param rooIdentifierFields (must not be null, but may be empty of no
     *            finders are defined)
     */
    public JavaTypePersistenceMetadataDetails(final JavaType identifierType,
            final FieldMetadata identifierField,
            final MethodMetadata identifierAccessorMethod,
            final MethodMetadata versionAccessorMethod,
            final MemberTypeAdditions persistMethod,
            final MemberTypeAdditions mergeMethod,
            final MemberTypeAdditions removeMethod,
            final MemberTypeAdditions findAllMethod,
            final MemberTypeAdditions findMethod,
            final MemberTypeAdditions countMethod,
            final MemberTypeAdditions findEntriesMethod,
            final List<String> finderNames, final boolean isRooIdentifier,
            final List<FieldMetadata> rooIdentifierFields) {
        Validate.notNull(identifierType, "Indentifier type required");
        Validate.notNull(identifierField, "Indentifier field required");
        Validate.notNull(identifierAccessorMethod,
                "Indentifier accessor method required");
        Validate.notNull(finderNames, "List of finder Names required");
        Validate.notNull(rooIdentifierFields,
                "List of fields for Roo identifier required (may be empty)");

        this.identifierType = identifierType;
        this.countMethod = countMethod;
        this.findAllMethod = findAllMethod;
        this.finderNames = finderNames;
        this.findMethod = findMethod;
        this.identifierAccessorMethod = identifierAccessorMethod;
        this.identifierField = identifierField;
        this.isRooIdentifier = isRooIdentifier;
        this.mergeMethod = mergeMethod;
        this.persistMethod = persistMethod;
        this.removeMethod = removeMethod;
        this.rooIdentifierFields = rooIdentifierFields;
        this.versionAccessorMethod = versionAccessorMethod;
        this.findEntriesMethod = findEntriesMethod;
    }

    /**
     * Accessor for persistence count method
     * 
     * @return the {@link MemberTypeAdditions} for the count method presented by
     *         the persistence MD (null if not defined)
     */
    public MemberTypeAdditions getCountMethod() {
        return countMethod;
    }

    /**
     * Accessor for persistence findAll method
     * 
     * @return the {@link MemberTypeAdditions} for the findAll method presented
     *         by the persistence MD (null if not defined)
     */
    public MemberTypeAdditions getFindAllMethod() {
        return findAllMethod;
    }

    /**
     * Accessor for persistence findEntries method
     * 
     * @return the {@link MemberTypeAdditions} for the findEntries method
     *         presented by the persistence MD (null if not defined)
     */
    public MemberTypeAdditions getFindEntriesMethod() {
        return findEntriesMethod;
    }

    /**
     * Accessor for finder names
     * 
     * @return list of finder names (may be empty)
     */
    public List<String> getFinderNames() {
        return finderNames;
    }

    /**
     * Accessor for persistence find method
     * 
     * @return the {@link MemberTypeAdditions} for the find method presented by
     *         the persistence MD (null if not defined)
     */
    public MemberTypeAdditions getFindMethod() {
        return findMethod;
    }

    /**
     * Accessor for persistence identifier
     * 
     * @return the {@link MethodMetadata} for the identifier accessor method
     *         presented by the persistence MD (never null)
     */
    public MethodMetadata getIdentifierAccessorMethod() {
        return identifierAccessorMethod;
    }

    /**
     * Field metadata for identifier
     * 
     * @return the {@link FieldMetadata} for the identifier field presented by
     *         the persistence MD (never null)
     */
    public FieldMetadata getIdentifierField() {
        return identifierField;
    }

    /**
     * Identifier Type
     * 
     * @return {@link JavaType} for id field
     */
    public JavaType getIdentifierType() {
        return identifierType;
    }

    /**
     * Accessor for persistence merge method
     * 
     * @return the {@link MemberTypeAdditions} for the merge method presented by
     *         the persistence MD (null if not defined)
     */
    public MemberTypeAdditions getMergeMethod() {
        return mergeMethod;
    }

    /**
     * Accessor for persistence persist method
     * 
     * @return the {@link MemberTypeAdditions} for the persist method presented
     *         by the persistence MD (null if not defined)
     */
    public MemberTypeAdditions getPersistMethod() {
        return persistMethod;
    }

    /**
     * Accessor for persistence remove method
     * 
     * @return the {@link MemberTypeAdditions} for the remove method presented
     *         by the persistence MD (null if not defined)
     */
    public MemberTypeAdditions getRemoveMethod() {
        return removeMethod;
    }

    /**
     * Accessor for identifier field collection in cases where the identifier
     * type is annotated with @RooIdentifier.
     * 
     * @return list of Field metadata for fields defined in the type annotated
     *         with @RooIdentifier
     */
    public List<FieldMetadata> getRooIdentifierFields() {
        return rooIdentifierFields;
    }

    /**
     * Accessor for persistence version
     * 
     * @return the {@link MethodMetadata} for the version accessor method
     *         presented by the persistence MD (null if not defined)
     */
    public MethodMetadata getVersionAccessorMethod() {
        return versionAccessorMethod;
    }

    /**
     * Indicate if this type is annotated with @RooIdentifier
     * 
     * @return true if annotation is present
     */
    public boolean isRooIdentifier() {
        return isRooIdentifier;
    }
}