org.kuali.rice.krad.datadictionary.parse

Class CustomTagAnnotations

java.lang.Object

org.kuali.rice.krad.datadictionary.parse.CustomTagAnnotations

public class CustomTagAnnotations
extends Object

Creates and stores the information defined for the custom schema. Loads the classes defined as having associated custom schemas and creates the information for the schema by parsing there annotations.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method and Description
protected static BeanTagAttribute.AttributeType	deriveTypeFromMethod(Method attributeMethod)
static String	findPropertyByType(String parentTag, String childTag)
protected static List<Class<?>>	findTagClasses(String basePackage) Finds all the classes which have a BeanTag or BeanTags annotation
static Map<String,Map<String,BeanTagAttributeInfo>>	getAttributeProperties() Retrieves a map of attribute and property information for the bean tags.
static Map<String,BeanTagAttributeInfo>	getAttributes(Class<?> tagClass) Creates a map of entries the properties marked by the annotation of the bean class.
static Map<String,BeanTagInfo>	getBeanTags() Retrieves the map of bean tags.
static Set<String>	getBeanTagsByClass(Class<?> clazz) Retrieves the set of tag names that are valid beans for the given class.
protected static boolean	isBeanTag(org.springframework.core.type.classreading.MetadataReader metadataReader) Returns true if the metadataReader representing the class has a BeanTag or BeanTags annotation
protected static boolean	isBeanType(Type type)
protected static boolean	isValueType(Type type)
protected static void	loadAttributeProperties(String tagName, Class<?> tagClass) Load the attribute information of the properties in the class repersented by the new tag.
protected static void	loadBeanTags() Load the information for the xml bean tags defined in the custom schema through annotation of the represented classes.
static void	loadTagClasses() Loads component classes for the custom schema by scanning configured packages.
static void	loadTagClasses(String[] scanPackages) Loads component classes for the custom schema by scanning the given packages.
protected static boolean	validateBeanTag(String tagName) Validates that the tag name is not already taken.

Methods inherited from class java.lang.Object

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

Method Detail

loadTagClasses

public static void loadTagClasses()

Loads component classes for the custom schema by scanning configured packages.

Packages to scan are configured using org.kuali.rice.krad.util.KRADConstants.ConfigParameters#SCHEMA_PACKAGES

loadTagClasses

public static void loadTagClasses(String[] scanPackages)

Loads component classes for the custom schema by scanning the given packages.

Parameters:

scanPackages - array of packages to scan

findTagClasses

protected static List<Class<?>> findTagClasses(String basePackage)
                                        throws IOException,
                                               ClassNotFoundException

Finds all the classes which have a BeanTag or BeanTags annotation

Parameters:

basePackage - the package to start in

Returns:

classes which have BeanTag or BeanTags annotation

Throws:

IOException

ClassNotFoundException

isBeanTag

protected static boolean isBeanTag(org.springframework.core.type.classreading.MetadataReader metadataReader)

Returns true if the metadataReader representing the class has a BeanTag or BeanTags annotation

Parameters:

metadataReader - MetadataReader representing the class to analyze

Returns:

true if BeanTag or BeanTags annotation is present

loadAttributeProperties

protected static void loadAttributeProperties(String tagName,
                                              Class<?> tagClass)

Load the attribute information of the properties in the class repersented by the new tag.

Parameters:

doc - the RescourceBundle containing the documentation

getAttributes

public static Map<String,BeanTagAttributeInfo> getAttributes(Class<?> tagClass)

Creates a map of entries the properties marked by the annotation of the bean class.

Parameters:

tagClass - class being mapped for attributes

Returns:

Return a map of the properties found in the class with there associated information.

deriveTypeFromMethod

protected static BeanTagAttribute.AttributeType deriveTypeFromMethod(Method attributeMethod)

isValueType

protected static boolean isValueType(Type type)

isBeanType

protected static boolean isBeanType(Type type)

loadBeanTags

protected static void loadBeanTags()

Load the information for the xml bean tags defined in the custom schema through annotation of the represented classes.

validateBeanTag

protected static boolean validateBeanTag(String tagName)

Validates that the tag name is not already taken.

Parameters:

tagName - the name of the tag for the new bean

Returns:

true if the validation passes, false otherwise

getBeanTags

public static Map<String,BeanTagInfo> getBeanTags()

Retrieves the map of bean tags. If the map has not been created yet the tags are loaded. The Bean tag map is created using the xml tag name of the bean as the key with the value consisting of information about the tag stored in a BeanTagInfo object.

Returns:

A map of xml tags and their associated information.

getBeanTagsByClass

public static Set<String> getBeanTagsByClass(Class<?> clazz)

Retrieves the set of tag names that are valid beans for the given class.

Parameters:

clazz - class to retrieve tag names for

Returns:

set of tag names as string, or null if none are found

getAttributeProperties

public static Map<String,Map<String,BeanTagAttributeInfo>> getAttributeProperties()

Retrieves a map of attribute and property information for the bean tags. if the map has not been created yet the bean tags are loaded. The attribute map is a double layer map with the outer layer consisting of the xml tag as the key linked to a inner map of all properties associated with it. The inner map uses the attribute or xml sub tag as the key to the information about the property stored in a BeanTagAttributeInfo object.

Returns:

A map of xml tags and their associated property information.

findPropertyByType

public static String findPropertyByType(String parentTag,
                                        String childTag)