org.designwizard.design
Interface DesignIF

All Known Implementing Classes:
Design

public interface DesignIF

Interface for Design. A Design is a model for the facts extracted from .class file and source code.

Author:
Jo�o Arthur Brunet Monteiro - joaoarthurbm@gmail.com

Field Summary
static java.lang.String FIELD_IDENTIFIER
           
static java.lang.String METHOD_IDENTIFIER
          Identifiers for methods and fields.
static java.lang.String STATIC_IDENTIFIER
           
 
Method Summary
 void addClassExtractedFromCode(java.lang.String className)
          Adds a class that was extrated from code.
 void addRelation(Relation.TypesOfRelation type, java.lang.String caller, java.lang.String called)
          Adds a new Relation on the Design.
 boolean containsEntity(java.lang.String entityName)
           
 java.util.Set<ClassNode> getAllClassesFromCode()
          Returns a Set containing Class objects that represents all classes from code.
 java.util.Collection<PackageNode> getAllPackagesFromCode()
           
 ClassNode getClass(java.lang.String className)
          Returns a ClassEntity represented by the specified className.
 Entity getEntity(java.lang.String name)
          Method that return the entity with the specified name.
 FieldNode getField(java.lang.String fieldName)
          Returns a Field with the specified name.
 MethodNode getMethod(java.lang.String methodName)
          Returns a Method with the specified name.
 PackageNode getPackage(java.lang.String fullyQualifiedNamePackage)
           
 void packageExtracted(java.lang.String entity)
           
 void resolveDependences()
          Resolve all dependences between entities after extraction.
 void setParameters(java.lang.String m, java.lang.String parameters)
           
 void setReturnType(java.lang.String m, java.lang.String returnType)
          Put the retunrType value on return type of the specified method.
 void setVisibility(java.lang.String method, Modifier visibility)
          Put the visibility value on visibility of the specified method.
 

Field Detail

METHOD_IDENTIFIER

static final java.lang.String METHOD_IDENTIFIER
Identifiers for methods and fields.

See Also:
Constant Field Values

STATIC_IDENTIFIER

static final java.lang.String STATIC_IDENTIFIER
See Also:
Constant Field Values

FIELD_IDENTIFIER

static final java.lang.String FIELD_IDENTIFIER
See Also:
Constant Field Values
Method Detail

addRelation

void addRelation(Relation.TypesOfRelation type,
                 java.lang.String caller,
                 java.lang.String called)
Adds a new Relation on the Design.

Parameters:
type - the type of the Relation.
caller - the caller of the Relation.
called - the called of the Relation.

getEntity

Entity getEntity(java.lang.String name)
                 throws InexistentEntityException
Method that return the entity with the specified name.

Parameters:
entityName - the name of the entity to be looked for.
Returns:
the entity with the specified name.
Throws:
InexistentEntityException

addClassExtractedFromCode

void addClassExtractedFromCode(java.lang.String className)
Adds a class that was extrated from code.

Parameters:
className - the name of the class extracted.

setVisibility

void setVisibility(java.lang.String method,
                   Modifier visibility)
                   throws InexistentEntityException
Put the visibility value on visibility of the specified method.

Parameters:
method -
visibility -
Throws:
InexistentEntityException

setReturnType

void setReturnType(java.lang.String m,
                   java.lang.String returnType)
                   throws InexistentEntityException
Put the retunrType value on return type of the specified method.

Parameters:
method -
visibility -
Throws:
InexistentEntityException

setParameters

void setParameters(java.lang.String m,
                   java.lang.String parameters)
                   throws InexistentEntityException
Throws:
InexistentEntityException

getClass

ClassNode getClass(java.lang.String className)
                   throws InexistentEntityException
Returns a ClassEntity represented by the specified className.

Parameters:
className - - the name of the class.
Returns:
a ClassEntity represented by the specified className.
Throws:
InexistentEntityException

getField

FieldNode getField(java.lang.String fieldName)
                   throws InexistentEntityException
Returns a Field with the specified name.

Parameters:
fieldName - the name of the field.
Returns:
a Field with the specified name.
Throws:
InexistentEntityException

getMethod

MethodNode getMethod(java.lang.String methodName)
                     throws InexistentEntityException
Returns a Method with the specified name.

Parameters:
methodName - the name of the method.
Returns:
a Method with the specified name.
Throws:
InexistentEntityException

getAllClassesFromCode

java.util.Set<ClassNode> getAllClassesFromCode()
Returns a Set containing Class objects that represents all classes from code.


resolveDependences

void resolveDependences()
Resolve all dependences between entities after extraction.


getAllPackagesFromCode

java.util.Collection<PackageNode> getAllPackagesFromCode()

packageExtracted

void packageExtracted(java.lang.String entity)

getPackage

PackageNode getPackage(java.lang.String fullyQualifiedNamePackage)
                       throws InexistentEntityException
Throws:
InexistentEntityException

containsEntity

boolean containsEntity(java.lang.String entityName)