org.apache.imperius.spl.core
Interface DataCollector

All Known Implementing Classes:
JavaDataCollectorImpl

public interface DataCollector


Method Summary
 boolean associationExists(java.lang.String nameSpace, java.lang.String sourceClassName, java.lang.String targetClassName, java.lang.String assocClass, java.lang.String role, java.lang.String resultRole)
          Determines whether an association between sourceClass and targetClass with the specified roles exist.
 java.util.List enumerateInstanceNames(java.lang.String className, java.lang.String qualifier)
          Get a list of Strings representing names of instances of the given class in the Operating Environment
 java.util.List getAssociatedInstanceReferences(java.lang.Object srcReference, java.lang.String namespace, java.lang.String resultInstancesClassFilter, java.lang.String assocClass, java.lang.String role, java.lang.String resultRole)
          This method is applicable to Domains that support the notion of associations.
 java.util.Map getSymbolsForClass(java.lang.String className, java.lang.String qualifier)
          Returns a Map of all the symbols (Properties and Methods) of the given class The Map is of the form String -> Symbol where Symbol can be a PropertySymbol or a MethodSymbol
 java.util.Map getSymbolsForInstance(java.lang.String className, java.lang.String qualifier, java.lang.Object instance)
          Returns a Map of instance values for the given instance The Map is of the form String (name of property or method) -> Object (instance value)
 boolean isInstance(java.lang.String className, java.lang.Object instance)
          Checks if the given object is an instance of the given class
 

Method Detail

getAssociatedInstanceReferences

java.util.List getAssociatedInstanceReferences(java.lang.Object srcReference,
                                               java.lang.String namespace,
                                               java.lang.String resultInstancesClassFilter,
                                               java.lang.String assocClass,
                                               java.lang.String role,
                                               java.lang.String resultRole)
                                               throws SPLException
This method is applicable to Domains that support the notion of associations. Associations are relations between 2 classes where each object has a role name and the association itself is a class. This method retrieves instances that are associated via a given association and roles to a source instance. This method is used to get instances o

Parameters:
className -
classPath -
resultInstancesClassFilter -
assocClass -
role -
resultRole -
srcReference -
Returns:
Throws:
SPLException

getSymbolsForClass

java.util.Map getSymbolsForClass(java.lang.String className,
                                 java.lang.String qualifier)
                                 throws SPLException
Returns a Map of all the symbols (Properties and Methods) of the given class The Map is of the form String -> Symbol where Symbol can be a PropertySymbol or a MethodSymbol

Parameters:
className -
qualifier -
Returns:
Map of symbols
Throws:
SPLException

getSymbolsForInstance

java.util.Map getSymbolsForInstance(java.lang.String className,
                                    java.lang.String qualifier,
                                    java.lang.Object instance)
                                    throws SPLException
Returns a Map of instance values for the given instance The Map is of the form String (name of property or method) -> Object (instance value)

Parameters:
className -
qualifier -
instance -
Returns:
Throws:
SPLException

associationExists

boolean associationExists(java.lang.String nameSpace,
                          java.lang.String sourceClassName,
                          java.lang.String targetClassName,
                          java.lang.String assocClass,
                          java.lang.String role,
                          java.lang.String resultRole)
                          throws SPLException
Determines whether an association between sourceClass and targetClass with the specified roles exist. This method is applicable only when associations between classes are supported by the operating environment

Parameters:
nameSpace -
className -
resultClass -
assocClass -
role -
resultRole -
Returns:
Throws:
SPLException

enumerateInstanceNames

java.util.List enumerateInstanceNames(java.lang.String className,
                                      java.lang.String qualifier)
                                      throws SPLException
Get a list of Strings representing names of instances of the given class in the Operating Environment

Parameters:
className -
qualifier -
Returns:
Throws:
SPLException

isInstance

boolean isInstance(java.lang.String className,
                   java.lang.Object instance)
                   throws SPLException
Checks if the given object is an instance of the given class

Throws:
SPLException