org.kuali.rice.kns.service.impl
Class BusinessObjectMetaDataServiceImpl

java.lang.Object
  org.kuali.rice.kns.service.impl.DataObjectMetaDataServiceImpl
      org.kuali.rice.kns.service.impl.BusinessObjectMetaDataServiceImpl

All Implemented Interfaces:

BusinessObjectMetaDataService, DataObjectMetaDataService

public class BusinessObjectMetaDataServiceImpl
extends DataObjectMetaDataServiceImpl
implements BusinessObjectMetaDataService

Implementation of the BusinessObjectMetaDataService which uses the following services to gather its meta data:

See Also:

BusinessObjectDictionaryService, DataDictionaryService, PersistenceStructureService

Field Summary

private BusinessObjectDictionaryService	businessObjectDictionaryService
private static org.apache.log4j.Logger	LOG

Constructor Summary

BusinessObjectMetaDataServiceImpl()

Method Summary

BusinessObjectDictionaryService	getBusinessObjectDictionaryService() Gets the businessObjectDictionaryService attribute.
BusinessObjectRelationship	getBusinessObjectRelationship(BusinessObject bo, Class boClass, String attributeName, String attributePrefix, boolean keysOnly)
BusinessObjectRelationship	getBusinessObjectRelationship(BusinessObject bo, String attributeName) This method will return a class that is related to the parent BO (either through the DataDictionary or through the PersistenceStructureService)
BusinessObjectRelationship	getBusinessObjectRelationship(RelationshipDefinition ddReference, BusinessObject bo, Class boClass, String attributeName, String attributePrefix, boolean keysOnly)
RelationshipDefinition	getBusinessObjectRelationshipDefinition(BusinessObject bo, String attributeName)
RelationshipDefinition	getBusinessObjectRelationshipDefinition(Class c, String attributeName)
List<BusinessObjectRelationship>	getBusinessObjectRelationships(BusinessObject bo) Get all the business object relationships for the given business object.
List<BusinessObjectRelationship>	getBusinessObjectRelationships(Class<? extends BusinessObject> boClass) Get all the business object relationships for the given class.
Collection<String>	getCollectionNames(BusinessObject bo) This method returns a list of collection names a business object contains
String	getForeignKeyFieldName(Class businessObjectClass, String attributeName, String targetName) This method ...
Collection<String>	getInquirableFieldNames(Class boClass, String sectionTitle) This method returns a list of inquirable field names
List<String>	getLookupableFieldNames(Class boClass) This method returns a list of lookupable fields
String	getLookupFieldDefaultValue(Class businessObjectClass, String attributeName) This method looks up the default value for a given attribute and returns it
Class	getLookupFieldDefaultValueFinderClass(Class businessObjectClass, String attributeName) This method returns the value finder class for a given attribute
String	getLookupFieldQuickfinderParameterString(Class businessObjectClass, String attributeName) This method looks up the quickfinder parameter string for a given attribute and returns it.
Class<? extends ValueFinder>	getLookupFieldQuickfinderParameterStringBuilderClass(Class businessObjectClass, String attributeName) This method returns the quickfinder parameter string builder class for a given attribute.
private Class	getNestedBOClass(BusinessObject bo, String attributeName) This method retrieves the business object class for a specific attribute
Map<String,Class>	getReferencesForForeignKey(BusinessObject bo, String attributeName) This method accepts a business object and one of its foreign key attribute names.
boolean	isAttributeInquirable(Class boClass, String attributeName, String sectionTitle) This method determines if a given field(attribute) is inquirable or not This handles both nested and non-nested attributes
boolean	isAttributeLookupable(Class boClass, String attributeName) This method determines if a given field(attribute) is lookupable or not This handles both nested and non-nested attributes
boolean	isInquirable(Class boClass) This method determines if a given business object is inquirable
boolean	isLookupable(Class boClass) This method determines if a given business object is lookupable
void	setBusinessObjectDictionaryService(BusinessObjectDictionaryService businessObjectDictionaryService) Sets the businessObjectDictionaryService attribute value.

Methods inherited from class org.kuali.rice.kns.service.impl.DataObjectMetaDataServiceImpl

equalsByPrimaryKeys, getDataDictionaryService, getDataObjectEntry, getDataObjectRelationship, getDataObjectRelationship, getDictionaryRelationship, getKualiModuleService, getPersistenceStructureService, getPrimaryKeyFieldValues, getPrimaryKeyFieldValues, getRelationshipMetadata, getTitleAttribute, getViewDictionaryService, listPrimaryKeyFieldNames, populateRelationshipFromDictionaryReference, setDataDictionaryService, setKualiModuleService, setPersistenceStructureService, setViewDictionaryService

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kns.service.DataObjectMetaDataService

equalsByPrimaryKeys, getDataObjectRelationship, getDictionaryRelationship, getPrimaryKeyFieldValues, getPrimaryKeyFieldValues, getTitleAttribute, listPrimaryKeyFieldNames

Field Detail

LOG

private static final org.apache.log4j.Logger LOG

businessObjectDictionaryService

private BusinessObjectDictionaryService businessObjectDictionaryService

Constructor Detail

BusinessObjectMetaDataServiceImpl

public BusinessObjectMetaDataServiceImpl()

Method Detail

getCollectionNames

public Collection<String> getCollectionNames(BusinessObject bo)

Description copied from interface: BusinessObjectMetaDataService

This method returns a list of collection names a business object contains

Specified by:

getCollectionNames in interface BusinessObjectMetaDataService

Returns:

getInquirableFieldNames

public Collection<String> getInquirableFieldNames(Class boClass,
                                                  String sectionTitle)

Description copied from interface: BusinessObjectMetaDataService

This method returns a list of inquirable field names

Specified by:

getInquirableFieldNames in interface BusinessObjectMetaDataService

Returns:

a collection of inquirable field names

getLookupableFieldNames

public List<String> getLookupableFieldNames(Class boClass)

Description copied from interface: BusinessObjectMetaDataService

This method returns a list of lookupable fields

Specified by:

getLookupableFieldNames in interface BusinessObjectMetaDataService

Returns:

a collection of lookupable fields

getLookupFieldDefaultValue

public String getLookupFieldDefaultValue(Class businessObjectClass,
                                         String attributeName)

Description copied from interface: BusinessObjectMetaDataService

This method looks up the default value for a given attribute and returns it

Specified by:

getLookupFieldDefaultValue in interface BusinessObjectMetaDataService

Returns:

default value for an attribute

getLookupFieldDefaultValueFinderClass

public Class getLookupFieldDefaultValueFinderClass(Class businessObjectClass,
                                                   String attributeName)

Description copied from interface: BusinessObjectMetaDataService

This method returns the value finder class for a given attribute

Specified by:

getLookupFieldDefaultValueFinderClass in interface BusinessObjectMetaDataService

Returns:

value finder class

getLookupFieldQuickfinderParameterString

public String getLookupFieldQuickfinderParameterString(Class businessObjectClass,
                                                       String attributeName)

This method looks up the quickfinder parameter string for a given attribute and returns it. See FieldDefinition.getQuickfinderParameterString().

Specified by:

getLookupFieldQuickfinderParameterString in interface BusinessObjectMetaDataService

Returns:

default values for attributes

getLookupFieldQuickfinderParameterStringBuilderClass

public Class<? extends ValueFinder> getLookupFieldQuickfinderParameterStringBuilderClass(Class businessObjectClass,
                                                                                         String attributeName)

This method returns the quickfinder parameter string builder class for a given attribute. See FieldDefinition.getQuickfinderParameterStringBuilderClass().

Specified by:

getLookupFieldQuickfinderParameterStringBuilderClass in interface BusinessObjectMetaDataService

Returns:

value finder class

isAttributeInquirable

public boolean isAttributeInquirable(Class boClass,
                                     String attributeName,
                                     String sectionTitle)

Description copied from interface: BusinessObjectMetaDataService

This method determines if a given field(attribute) is inquirable or not This handles both nested and non-nested attributes

Specified by:

isAttributeInquirable in interface BusinessObjectMetaDataService

Returns:

true if field is inquirable

isInquirable

public boolean isInquirable(Class boClass)

Description copied from interface: BusinessObjectMetaDataService

This method determines if a given business object is inquirable

Specified by:

isInquirable in interface BusinessObjectMetaDataService

Returns:

true if bo is inquirable

isAttributeLookupable

public boolean isAttributeLookupable(Class boClass,
                                     String attributeName)

Description copied from interface: BusinessObjectMetaDataService

This method determines if a given field(attribute) is lookupable or not This handles both nested and non-nested attributes

Specified by:

isAttributeLookupable in interface BusinessObjectMetaDataService

Returns:

true if field is lookupable

isLookupable

public boolean isLookupable(Class boClass)

Description copied from interface: BusinessObjectMetaDataService

This method determines if a given business object is lookupable

Specified by:

isLookupable in interface BusinessObjectMetaDataService

Returns:

true if bo is lookupable

getBusinessObjectRelationship

public BusinessObjectRelationship getBusinessObjectRelationship(BusinessObject bo,
                                                                String attributeName)

Description copied from interface: BusinessObjectMetaDataService

This method will return a class that is related to the parent BO (either through the DataDictionary or through the PersistenceStructureService)

Specified by:

getBusinessObjectRelationship in interface BusinessObjectMetaDataService

Returns:

related class

getBusinessObjectRelationship

public BusinessObjectRelationship getBusinessObjectRelationship(RelationshipDefinition ddReference,
                                                                BusinessObject bo,
                                                                Class boClass,
                                                                String attributeName,
                                                                String attributePrefix,
                                                                boolean keysOnly)

Specified by:

getBusinessObjectRelationship in interface BusinessObjectMetaDataService

getBusinessObjectRelationshipDefinition

public RelationshipDefinition getBusinessObjectRelationshipDefinition(Class c,
                                                                      String attributeName)

Specified by:

getBusinessObjectRelationshipDefinition in interface BusinessObjectMetaDataService

getBusinessObjectRelationshipDefinition

public RelationshipDefinition getBusinessObjectRelationshipDefinition(BusinessObject bo,
                                                                      String attributeName)

Specified by:

getBusinessObjectRelationshipDefinition in interface BusinessObjectMetaDataService

getBusinessObjectRelationship

public BusinessObjectRelationship getBusinessObjectRelationship(BusinessObject bo,
                                                                Class boClass,
                                                                String attributeName,
                                                                String attributePrefix,
                                                                boolean keysOnly)

Specified by:

getBusinessObjectRelationship in interface BusinessObjectMetaDataService

getBusinessObjectDictionaryService

public BusinessObjectDictionaryService getBusinessObjectDictionaryService()

Gets the businessObjectDictionaryService attribute.

Returns:

Returns the businessObjectDictionaryService.

setBusinessObjectDictionaryService

public void setBusinessObjectDictionaryService(BusinessObjectDictionaryService businessObjectDictionaryService)

Sets the businessObjectDictionaryService attribute value.

Parameters:

businessObjectDictionaryService - The BusinessObjectDictionaryService to set.

getNestedBOClass

private Class getNestedBOClass(BusinessObject bo,
                               String attributeName)

This method retrieves the business object class for a specific attribute

Parameters:

bo -

attributeName -

Returns:

a business object class for a specific attribute

getBusinessObjectRelationships

public List<BusinessObjectRelationship> getBusinessObjectRelationships(BusinessObject bo)

Description copied from interface: BusinessObjectMetaDataService

Get all the business object relationships for the given business object. These relationships may be defined at the ORM-layer or within the data dictionary.

Specified by:

getBusinessObjectRelationships in interface BusinessObjectMetaDataService

getBusinessObjectRelationships

public List<BusinessObjectRelationship> getBusinessObjectRelationships(Class<? extends BusinessObject> boClass)

Description copied from interface: BusinessObjectMetaDataService

Get all the business object relationships for the given class. These relationships may be defined at the ORM-layer or within the data dictionary.

Specified by:

getBusinessObjectRelationships in interface BusinessObjectMetaDataService

getReferencesForForeignKey

public Map<String,Class> getReferencesForForeignKey(BusinessObject bo,
                                                    String attributeName)

Description copied from interface: BusinessObjectMetaDataService

This method accepts a business object and one of its foreign key attribute names. It returns a map that has a foreign key attribute name as a key and its respective related class as value. If the passed in attributeName is not a foreign key, this method will return an empty map.

Specified by:

getReferencesForForeignKey in interface BusinessObjectMetaDataService

Returns:

Map

See Also:

org.kuali.rice.kns.service.BusinessObjectMetaDataService#getReferencesForForeignKey(java.lang.Class, java.lang.String)

getForeignKeyFieldName

public String getForeignKeyFieldName(Class businessObjectClass,
                                     String attributeName,
                                     String targetName)

Description copied from interface: BusinessObjectMetaDataService

This method ...

Specified by:

getForeignKeyFieldName in interface BusinessObjectMetaDataService

Returns: