Workset

java.lang.Object
- org.pfsw.tools.cda.base.model.AModelObject
- - org.pfsw.tools.cda.base.model.AAnalyzableElement
  - - org.pfsw.tools.cda.base.model.Workset

All Implemented Interfaces:

java.lang.Comparable<AModelObject>, org.pfsw.bif.lifecycle.IReleasable, org.pfsw.odem.IExplorableElement, org.pfsw.odem.IExplorableElementVisiting, org.pfsw.odem.IExplorationContext, org.pfsw.odem.IExplorationModelObject, org.pfsw.odem.IObjectProperties, IAnalyzableElement, IClassContainingElement, IWorksetInitializationListener
```
public class Workset
extends AAnalyzableElement
implements org.pfsw.odem.IExplorationContext, IClassContainingElement, IWorksetInitializationListener
```
Contains all relevant information for one complete set of elements that are analyzed together. There is nothing outside a Workset that an analyzer takes into account.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.pfsw.tools.cda.base.model.workset.IWorksetInitializationListener
  IWorksetInitializationListener.EventType

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ATTR_DIRTY
- Fields inherited from class org.pfsw.tools.cda.base.model.AModelObject
  EMPTY_MODEL_OBJECT_ARRAY
- Fields inherited from interface org.pfsw.tools.cda.base.model.IAnalyzableElement
  EMPTY_BASE_ARRAY

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTR_DIRTY`

Constructor Summary

Constructors
Constructor and Description
`Workset(java.lang.String worksetName)` Initialize the new instance with a name.
`Workset(java.lang.String worksetName, java.lang.String... classpathElements)` Convenience constructor that allows to specify a new workset with the given name and an arbitrary list or classpath elements (folders, jar files, war files, ...).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(org.pfsw.odem.IExplorableElementVisitor visitor)` Implementation of the visitor pattern (GOF) for all derived interfaces if IExplorableElement.
`boolean`	`acceptTypes(org.pfsw.odem.ITypesVisitor visitor)` Implementation of the visitor pattern (GOF) for all derived interfaces if IExplorableElement.
`void`	`addClasspathPartDefinition(ClasspathPartDefinition partDefinition)` Adds the classpath definition to this workset.
`void`	`addClasspathPartDefinitions(ClasspathPartDefinition... partDefinitions)` Adds all specified classpath definitions to this workset.
`void`	`addIgnoreFilter(StringFilter filter)` Adds the given filter to the filter collection that defines which classes should be ignored (i.e.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Add a listener that will be informed about important property changes.
`void`	`addReleaseListener(org.pfsw.bif.lifecycle.IReleasable releasable)` Add a listener that should be notified when this workset gets released.
`void`	`addViewFilter(StringFilter filter)` Adds the given filter to the view filter collection that defines which classes should not be shown as dependencies.
`boolean`	`areAllClassesCollected()` Returns true if all classes have been collected.
`boolean`	`areAllContainersInitialized()` Returns true if all containers of this workset have been initialized.
`boolean`	`areAllDependenciesResolved()` Returns true if all elements in this workset have been sufficiently resolved.
`void`	`beClean()` Sets the internal state to NOT dirty.
`void`	`beDirty()` Sets the internal state to not dirty.
`boolean`	`canBeAnalyzedForDependencies()` Returns true if this element can (currently) be analyzed for its dependencies to other elements.
`ClasspathPartDefinition[]`	`classpathDefinitions()` Returns an array of this workset's classpath part definitions.
`void`	`closeAllPhysicalContainers()` Closes all underlying files of physical class containers (e.g.
`protected CollectionUtil`	`coll()`
`Workset`	`copy()` Returns a copy of this workset, where all internal elements are also copies of their origins.
`protected java.util.List<ClasspathPartDefinition>`	`copyClasspathParts()`
`java.util.List<ClassInformation>`	`findClassInfos(ClassInformationFilter classFilter)` Finds all classInfo object that match the given filter.
`java.util.List<ClassInformation>`	`findClassInfos(java.util.Collection<java.lang.String> classNames)` Finds all classInfo object that correspond to the given class names.
`java.lang.Object`	`findInCache(java.lang.String section, java.lang.Object key)` Tries to find a cached object that was stored under the given key in the specified cache section.
`boolean`	`followClass(java.lang.String className)` Returns true, if an analyzer should follow the class with the given name.
`ClassInformation[]`	`getAllContainedClasses()` Returns all classes that are contained in this element or any of its structural sub-elements.
`AnalyzableElementType`	`getAnalyzableElementType()` Returns the type of the analyzable element.
`java.lang.Boolean`	`getAutoReloadable()`
`protected StructuredCache`	`getCache()`
`java.lang.Boolean`	`getCalculatingHashesEnabled()`
`int`	`getChildCount()` Returns the current number of children.
`AModelObject[]`	`getChildren()` Returns the children
`GenericClassContainer[]`	`getClassContainers()` Returns the array or all class containers that are currently in this workset.
`ClassInformation`	`getClassInfo(java.lang.String className)` Returns the ClassInformation object corresponding to the given className.
`protected IClassInformationFactory`	`getClassInformationFactory()`
`ClasspathMetadata`	`getClasspathMetadata()`
`java.util.List<ClasspathPartDefinition>`	`getClasspathParts()` Returns all the classpath element definitions that are specified for this workset
`IClassSpace`	`getClassSpace()` Returns the class space of this workset which holds all class containers
`protected ClassSpace`	`getClassSpaceAndFactory()`
`ComponentModel`	`getComponentModel()`
`SoftwareComponent[]`	`getComponents()`
`java.util.Collection<org.pfsw.odem.IContainer>`	`getContainers()` Returns a collection of all class containers that are currently contained in this workset.
`org.pfsw.odem.IExplorationContext`	`getContext()` Returns this workset itself
`java.lang.String`	`getDescription()` Returns the description of this workset
`java.lang.String`	`getFilename()` Returns the name of the file this workset was loaded from
`StringFilterCollection`	`getFollowIgnorePatterns()` Return the filters that define which classes must not be analyzed
`protected ClassFileVersion`	`getHighestClassFileVersion()`
`java.lang.Boolean`	`getIncludeResourceFiles()`
`protected org.pfsw.tools.cda.base.model.Workset.InitState`	`getInitState()`
`Variables`	`getLocalVariables()`
`java.lang.String`	`getName()` Returns the name of this workset
`GenericClassContainer`	`getNotFoundClassesContainer()` Returns the special container that is used to hold all classes that are referred to from other classes, but are not found in any container of the specified classpath parts.
`int`	`getNumberOfClassContainers()` Returns the number of containers in this workset
`int`	`getNumberOfContainedClasses()` Returns the number of classes in this workset
`int`	`getNumberOfContainedPackages()` Returns the number of packages in this container
`int`	`getNumberOfContainedResources()` Returns the number of resources in this workset.
`protected AModelObject`	`getParent()` Returns the parent model object, which is always null for a workset.
`ClassContainer[]`	`getPhysicalClassContainers()` Returns all "physical" containers (i.e.
`protected java.beans.PropertyChangeSupport`	`getPropertyChangeSupport()`
`protected java.util.List<org.pfsw.bif.lifecycle.IReleasable>`	`getReleaseListeners()`
`ClassFileVersion`	`getRequiredClassFileVersion()` Returns the highest class file version that one of the contained classes is based on.
`int`	`getResolvedClassesCounter()` Returns the internal counter for resolved classes.
`java.lang.Boolean`	`getShortContainerNames()`
`java.lang.Boolean`	`getSpringBeanAnalysisEnabled()`
`long`	`getTimeForClassResolving()` Returns the time (in milliseconds) that has been passed (so far) to resolve all classes in this workset.
`VariablePool`	`getVariablePool()`
`StringFilterCollection`	`getViewFilters()` Returns the filter collection that is defined to prevent classes from being displayed.
`Workset`	`getWorkset()` Returns this workset
`protected boolean`	`hasParent()` Returns true if this object has a parent model object.
`void`	`incResolvedClassesCounter()` Increments the internal counter for resolved classes by 1.
`protected void`	`initHighestClassFileVersion()`
`void`	`initializationEvent(IWorksetInitializationListener.EventType type, Workset workset)` Will be called for each event during workset initialization.
`protected void`	`initPhysicalContainers()` Iterate over all (physical) containers and initialize them from additional meta-data.
`protected java.lang.String`	`inspectString()` Returns a string representation that is more convenient for object inspection with JOI.
`boolean`	`isAutoReloadable()` Returns true if this workset should automatically be reloaded on startup if it was loaded at last shutdown.
`boolean`	`isCalculatingHashesEnabled()`
`boolean`	`isDirty()` Returns true, if the workset has been modified
`protected void`	`isDirty(boolean newValue)`
`protected boolean`	`isEqual(java.util.List<ClasspathPartDefinition> listA, java.util.List<ClasspathPartDefinition> listB)`
`boolean`	`isIncludeResourceFilesOn()` Returns true if for this workset container should include resource files in its container analysis.
`boolean`	`isNew()` Returns true, if this workset has not been made persistent and therefore has no filename associated.
`boolean`	`isShortContainerNamesOn()` Returns true if for this workset container names should be shown in a short form.
`boolean`	`isSpringAnalysisEnabled()` Returns whether or not dependencies should also be detected by analyzing spring bean declarations.
`void`	`modifyAutoReloadable(java.lang.Boolean bool)` Sets the new value for the auto-reload flag and changes the state of the workset to dirty.
`void`	`modifyCalculatingHashesEnabled(java.lang.Boolean enabled)` Sets whether or not calculation of hashes is supported.
`void`	`modifyDescription(java.lang.String newDescription)` Sets the new description and changes the state of the workset to dirty.
`void`	`modifyIgnorePatterns(StringFilterCollection newPatterns)` Sets the new ignore patterns and changes the state of the workset to dirty.
`void`	`modifyIncludeResourceFiles(java.lang.Boolean bool)` Sets the new value for the includeResourceFiles flag and changes the state of the workset to dirty.
`void`	`modifyName(java.lang.String newName)` Sets the new name and changes the state of the workset to dirty.
`void`	`modifyShortContainerNames(java.lang.Boolean bool)` Sets the new value for the shortContainerNames flag and changes the state of the workset to dirty.
`void`	`modifySpringBeanAnalysisEnabled(java.lang.Boolean enabled)` Sets whether or not dependencies should also be detected by analyzing spring bean declarations.
`void`	`modifyViewFilters(StringFilterCollection newFilters)` Sets the new view filters and changes the state of the workset to dirty.
`boolean`	`processClassContainersObjects(java.util.Collection<GenericClassContainer> collection, IGenericClassContainerProcessor processor)` Calls the given processor's process() method for each contained class container object and adds all class package objects that the processor wants (matches) to the given collection.
`boolean`	`processClassContainersObjects(IGenericClassContainerProcessor processor)` Calls the given processor's process() method for each contained class container object.
`boolean`	`processClassInformationObjects(java.util.Collection<ClassInformation> collection, IClassInformationProcessor<?> processor)` Calls the given processor for each contained class info object and adds all class info objects that the processor wants (matches) to the given collection.
`boolean`	`processClassInformationObjects(IClassInformationProcessor<ClassInformation> processor)` Calls the given processor for each contained class info object.
`boolean`	`processClassPackageObjects(java.util.Collection<ClassPackage> collection, IClassPackageProcessor processor)` Calls the given processor for each contained class package object and adds all class package objects that the processor wants (matches) to the given collection (if the collection is not null).
`boolean`	`processClassPackageObjects(IClassPackageProcessor processor)` Calls the given processor's process() method for each contained class package object.
`boolean`	`processResourceInformationObjects(IResourceInformationProcessor processor)` Calls the given processor for each contained resource info object in all containers.
`boolean`	`processSoftwareComponents(java.util.Collection<SoftwareComponent> collection, ISoftwareComponentProcessor processor)` Calls the given processor for each contained component object and adds all component objects that the processor wants to the given collection.
`boolean`	`processSpringBeans(ISpringBeanProcessor beanProcessor)` Calls the given processor for each contained spring bean object in all containers.
`boolean`	`refersTo(IAnalyzableElement element)` Returns always false
`void`	`release()` Release all referred resources (particularly the cache) and archives that have been extracted to temporary folders.
`protected void`	`releaseContainers()`
`void`	`releaseForReInitialization()` Release archives that have been extracted to temporary folders.
`protected void`	`releasePhysicalContainers()` Iterate over all physical containers and inform them that it is now okay to release any external resources (e.g.
`protected void`	`releaseReleasables()`
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Removes a listener so that it will not be informed about important property changes anymore.
`void`	`removeReleaseListener(org.pfsw.bif.lifecycle.IReleasable releasable)` Removes a formerly added listener for releasing resources.
`protected void`	`resetCache()`
`protected void`	`resetClasspathParts()`
`protected void`	`resetClassSpace()`
`protected void`	`resetFollowIgnorePatterns()`
`protected void`	`resetResolvedClasses()`
`protected void`	`resetVariables()`
`protected void`	`resetViewFilters()`
`void`	`setAutoReloadable(java.lang.Boolean newValue)`
`protected void`	`setCache(StructuredCache newValue)`
`void`	`setCalculatingHashesEnabled(java.lang.Boolean calculatingHashesEnabled)`
`protected void`	`setClasspathMetadata(ClasspathMetadata newValue)`
`protected void`	`setClasspathParts(java.util.List<ClasspathPartDefinition> newValue)`
`void`	`setClassSpaceAndFactory(ClassSpace newValue)`
`void`	`setComponentModel(ComponentModel newValue)`
`void`	`setDescription(java.lang.String newValue)` Sets the description of this workset
`void`	`setFilename(java.lang.String newValue)` Sets the filename this workset was stored under
`protected void`	`setFollowIgnorePatterns(StringFilterCollection newValue)`
`void`	`setGlobalVariables(Variables vars)`
`protected void`	`setHighestClassFileVersion(ClassFileVersion newValue)`
`void`	`setIncludeResourceFiles(java.lang.Boolean includeResourceFiles)`
`protected void`	`setInitState(org.pfsw.tools.cda.base.model.Workset.InitState newValue)`
`void`	`setLocalVariables(Variables vars)`
`protected void`	`setName(java.lang.String newValue)`
`protected void`	`setPropertyChangeSupport(java.beans.PropertyChangeSupport newValue)`
`void`	`setShortContainerNames(java.lang.Boolean newValue)`
`void`	`setSpringBeanAnalysisEnabled(java.lang.Boolean springBeanAnalysisEnabled)`
`protected void`	`setVariablePool(VariablePool newValue)`
`protected void`	`setViewFilters(StringFilterCollection newValue)`
`void`	`storeInCache(java.lang.String section, java.lang.Object key, java.lang.Object value)` Stores the given value under the specified key in the given section of the cache.
`java.lang.String`	`toString()`
`boolean`	`updateFrom(Workset anotherWorkset)` Takes over all data from the given workset and then resets internal caches and dependent information.

Methods inherited from class org.pfsw.tools.cda.base.model.AModelObject
apply, applyOnChildren, applyOnStack, applySelf, canHaveDependencies, compareTo, countAllElementsRecursivly, getNumberOfAncestors, getOtherProperties, getProperty, getPropertyNames, setOtherProperties, setProperty, str, visitStackObjects

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pfsw.odem.IObjectProperties
getProperty, getPropertyNames, setProperty

- Field Detail
  - ATTR_DIRTY
```
public static final java.lang.String ATTR_DIRTY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Workset
```
public Workset(java.lang.String worksetName)
```
    Initialize the new instance with a name.
    
    Parameters:
    
    worksetName - The name of the new workset (must not be null).
    
    Throws:
    
    java.lang.IllegalArgumentException - if worksetName is null.
  - Workset
```
public Workset(java.lang.String worksetName,
               java.lang.String... classpathElements)
```
    Convenience constructor that allows to specify a new workset with the given name and an arbitrary list or classpath elements (folders, jar files, war files, ...).
    
    Parameters:
    
    worksetName -
    
    classpathElements -
- Method Detail
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Add a listener that will be informed about important property changes.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Removes a listener so that it will not be informed about important property changes anymore.
  - getClassInfo
```
public ClassInformation getClassInfo(java.lang.String className)
```
    Returns the ClassInformation object corresponding to the given className. The result might be a newly created instance of ClassInformation or an already in the repository existing object.
    
    Parameters:
    
    className - The fully qualified class name (must not be null).
  - getClassSpace
```
public IClassSpace getClassSpace()
```
    Returns the class space of this workset which holds all class containers
  - followClass
```
public boolean followClass(java.lang.String className)
```
    Returns true, if an analyzer should follow the class with the given name. That is, analyze it as well.
  - addIgnoreFilter
```
public void addIgnoreFilter(StringFilter filter)
```
    Adds the given filter to the filter collection that defines which classes should be ignored (i.e. not been analyzed)
  - addViewFilter
```
public void addViewFilter(StringFilter filter)
```
    Adds the given filter to the view filter collection that defines which classes should not be shown as dependencies.
  - addClasspathPartDefinition
```
public void addClasspathPartDefinition(ClasspathPartDefinition partDefinition)
```
    Adds the classpath definition to this workset.
  - addClasspathPartDefinitions
```
public void addClasspathPartDefinitions(ClasspathPartDefinition... partDefinitions)
```
    Adds all specified classpath definitions to this workset.
  - getClassContainers
```
public GenericClassContainer[] getClassContainers()
```
    Returns the array or all class containers that are currently in this workset.
  - getContainers
```
public java.util.Collection<org.pfsw.odem.IContainer> getContainers()
```
    Returns a collection of all class containers that are currently contained in this workset.
    
    Specified by:
    
    getContainers in interface org.pfsw.odem.IExplorationContext
  - getPhysicalClassContainers
```
public ClassContainer[] getPhysicalClassContainers()
```
    Returns all "physical" containers (i.e. no virtual containers).
  - getNotFoundClassesContainer
```
public GenericClassContainer getNotFoundClassesContainer()
```
    Returns the special container that is used to hold all classes that are referred to from other classes, but are not found in any container of the specified classpath parts.
  - classpathDefinitions
```
public ClasspathPartDefinition[] classpathDefinitions()
```
    Returns an array of this workset's classpath part definitions.
  - getAllContainedClasses
```
public ClassInformation[] getAllContainedClasses()
```
    Returns all classes that are contained in this element or any of its structural sub-elements. If no classes are contained, an empty array will be returned.
    
    Specified by:
    
    getAllContainedClasses in interface IAnalyzableElement
  - storeInCache
```
public void storeInCache(java.lang.String section,
                         java.lang.Object key,
                         java.lang.Object value)
```
    Stores the given value under the specified key in the given section of the cache.
    
    Parameters:
    
    section - The name of the cache section
    
    key - The key under which the value can be found again
    
    value - The object to cache
  - findInCache
```
public java.lang.Object findInCache(java.lang.String section,
                                    java.lang.Object key)
```
    Tries to find a cached object that was stored under the given key in the specified cache section.
    
    Parameters:
    
    section - The name of the section
    
    key - The key under which the value can be found
    
    Returns:
    
    The desired object or null if not found
  - findClassInfos
```
public java.util.List<ClassInformation> findClassInfos(ClassInformationFilter classFilter)
```
    Finds all classInfo object that match the given filter.
    
    Parameters:
    
    classFilter - The filter that decides which classes are returned (must not be null).
    
    Returns:
    
    A (perhaps empty) collection of the found classes.
  - findClassInfos
```
public java.util.List<ClassInformation> findClassInfos(java.util.Collection<java.lang.String> classNames)
```
    Finds all classInfo object that correspond to the given class names.
    
    Parameters:
    
    classNames - The full qualified class names to be found (must not be null).
    
    Returns:
    
    A (perhaps empty) collection of the found classes.
  - release
```
public void release()
```
    Release all referred resources (particularly the cache) and archives that have been extracted to temporary folders.
    
    Specified by:
    
    release in interface org.pfsw.bif.lifecycle.IReleasable
  - releaseForReInitialization
```
public void releaseForReInitialization()
```
    Release archives that have been extracted to temporary folders.
  - closeAllPhysicalContainers
```
public void closeAllPhysicalContainers()
```
    Closes all underlying files of physical class containers (e.g. JAR files),
  - areAllContainersInitialized
```
public boolean areAllContainersInitialized()
```
    Returns true if all containers of this workset have been initialized.
  - incResolvedClassesCounter
```
public void incResolvedClassesCounter()
```
    Increments the internal counter for resolved classes by 1.
  - areAllDependenciesResolved
```
public boolean areAllDependenciesResolved()
```
    Returns true if all elements in this workset have been sufficiently resolved. This is a prerequisite to do any analysis on the contained elements.
  - areAllClassesCollected
```
public boolean areAllClassesCollected()
```
    Returns true if all classes have been collected. This however leaves open if their dependencies have been resolved yet.
    
    See Also:
    
    areAllDependenciesResolved()
  - isAutoReloadable
```
public boolean isAutoReloadable()
```
    Returns true if this workset should automatically be reloaded on startup if it was loaded at last shutdown.
  - isSpringAnalysisEnabled
```
public boolean isSpringAnalysisEnabled()
```
    Returns whether or not dependencies should also be detected by analyzing spring bean declarations.
  - isShortContainerNamesOn
```
public boolean isShortContainerNamesOn()
```
    Returns true if for this workset container names should be shown in a short form.
  - isIncludeResourceFilesOn
```
public boolean isIncludeResourceFilesOn()
```
    Returns true if for this workset container should include resource files in its container analysis.
  - canBeAnalyzedForDependencies
```
public boolean canBeAnalyzedForDependencies()
```
    Returns true if this element can (currently) be analyzed for its dependencies to other elements. A workset itself has no dependencies and therefore always returns false here.
    
    Specified by:
    
    canBeAnalyzedForDependencies in interface IAnalyzableElement
    
    Overrides:
    
    canBeAnalyzedForDependencies in class AAnalyzableElement
  - beClean
```
public void beClean()
```
    Sets the internal state to NOT dirty.
  - beDirty
```
public void beDirty()
```
    Sets the internal state to not dirty.
  - modifyName
```
public void modifyName(java.lang.String newName)
```
    Sets the new name and changes the state of the workset to dirty.
  - modifyDescription
```
public void modifyDescription(java.lang.String newDescription)
```
    Sets the new description and changes the state of the workset to dirty.
  - modifyAutoReloadable
```
public void modifyAutoReloadable(java.lang.Boolean bool)
```
    Sets the new value for the auto-reload flag and changes the state of the workset to dirty.
  - modifyShortContainerNames
```
public void modifyShortContainerNames(java.lang.Boolean bool)
```
    Sets the new value for the shortContainerNames flag and changes the state of the workset to dirty.
  - modifyIncludeResourceFiles
```
public void modifyIncludeResourceFiles(java.lang.Boolean bool)
```
    Sets the new value for the includeResourceFiles flag and changes the state of the workset to dirty.
  - modifySpringBeanAnalysisEnabled
```
public void modifySpringBeanAnalysisEnabled(java.lang.Boolean enabled)
```
    Sets whether or not dependencies should also be detected by analyzing spring bean declarations.
  - modifyCalculatingHashesEnabled
```
public void modifyCalculatingHashesEnabled(java.lang.Boolean enabled)
```
    Sets whether or not calculation of hashes is supported.
  - modifyViewFilters
```
public void modifyViewFilters(StringFilterCollection newFilters)
```
    Sets the new view filters and changes the state of the workset to dirty.
  - modifyIgnorePatterns
```
public void modifyIgnorePatterns(StringFilterCollection newPatterns)
```
    Sets the new ignore patterns and changes the state of the workset to dirty.
  - copy
```
public Workset copy()
```
    Returns a copy of this workset, where all internal elements are also copies of their origins.
    The following instance variables are not copied:
    - classSpace
    - cache
    - filename
    - isDirty
    The copy has always the 'dirty' state clean!
  - updateFrom
```
public boolean updateFrom(Workset anotherWorkset)
```
    Takes over all data from the given workset and then resets internal caches and dependent information.
    
    Returns:
    
    true if the workset must be re-initialized
  - isNew
```
public boolean isNew()
```
    Returns true, if this workset has not been made persistent and therefore has no filename associated.
  - getTimeForClassResolving
```
public long getTimeForClassResolving()
```
    Returns the time (in milliseconds) that has been passed (so far) to resolve all classes in this workset.
  - setGlobalVariables
```
public void setGlobalVariables(Variables vars)
```
  - getLocalVariables
```
public Variables getLocalVariables()
```
  - setLocalVariables
```
public void setLocalVariables(Variables vars)
```
  - getNumberOfContainedClasses
```
public int getNumberOfContainedClasses()
```
    Returns the number of classes in this workset
    
    Specified by:
    
    getNumberOfContainedClasses in interface IClassContainingElement
  - getNumberOfContainedPackages
```
public int getNumberOfContainedPackages()
```
    Returns the number of packages in this container
  - getNumberOfClassContainers
```
public int getNumberOfClassContainers()
```
    Returns the number of containers in this workset
  - getNumberOfContainedResources
```
public int getNumberOfContainedResources()
```
    Returns the number of resources in this workset.
  - getRequiredClassFileVersion
```
public ClassFileVersion getRequiredClassFileVersion()
```
    Returns the highest class file version that one of the contained classes is based on. Returns null if no class can be found in this package.
    
    Specified by:
    
    getRequiredClassFileVersion in interface IClassContainingElement
  - processClassInformationObjects
```
public boolean processClassInformationObjects(java.util.Collection<ClassInformation> collection,
                                              IClassInformationProcessor<?> processor)
```
    Calls the given processor for each contained class info object and adds all class info objects that the processor wants (matches) to the given collection.
    
    Parameters:
    
    collection - The collection to which the matching objects will be added. If this parameter is null only the process() method of the given processor will be called, but never the matches() method.
    
    processor - The processor that decides whether or not an object must be added (must not be null).
    
    Returns:
    
    true if processing should continue, otherwise false.
  - processClassInformationObjects
```
public boolean processClassInformationObjects(IClassInformationProcessor<ClassInformation> processor)
```
    Calls the given processor for each contained class info object. That is, the process() method of the given processor will be invoked for each class in this workset.
    
    Parameters:
    
    processor - The processor that gets called for each class object.
    
    Returns:
    
    true if processing should continue, otherwise false.
  - processClassPackageObjects
```
public boolean processClassPackageObjects(java.util.Collection<ClassPackage> collection,
                                          IClassPackageProcessor processor)
```
    Calls the given processor for each contained class package object and adds all class package objects that the processor wants (matches) to the given collection (if the collection is not null).
    
    Parameters:
    
    collection - The collection to which the matching objects will be added. If this parameter is null only the process() method of the given processor will be called, but never the matches() method.
    
    processor - The processor that decides whether or not an object must be added (must not be null)
    
    Returns:
    
    true if processing should continue, otherwise false.
  - processClassPackageObjects
```
public boolean processClassPackageObjects(IClassPackageProcessor processor)
```
    Calls the given processor's process() method for each contained class package object.
    
    Parameters:
    
    processor - The processor that that will be invoked for each package (must not be null).
    
    Returns:
    
    true if processing should continue, otherwise false.
  - processClassContainersObjects
```
public boolean processClassContainersObjects(java.util.Collection<GenericClassContainer> collection,
                                             IGenericClassContainerProcessor processor)
```
    Calls the given processor's process() method for each contained class container object and adds all class package objects that the processor wants (matches) to the given collection.
    
    Parameters:
    
    collection - The collection to which the matching objects will be added. If this parameter is null only the process() method of the given processor will be called, but never the matches() method.
    
    processor - The processor that decides whether or not an object must be added (must not be null).
    
    Returns:
    
    true if processing should continue, otherwise false.
  - processClassContainersObjects
```
public boolean processClassContainersObjects(IGenericClassContainerProcessor processor)
```
    Calls the given processor's process() method for each contained class container object.
    
    Parameters:
    
    processor - The processor that gets called for each container.
    
    Returns:
    
    true if processing should continue, otherwise false.
  - processSoftwareComponents
```
public boolean processSoftwareComponents(java.util.Collection<SoftwareComponent> collection,
                                         ISoftwareComponentProcessor processor)
```
    Calls the given processor for each contained component object and adds all component objects that the processor wants to the given collection.
    
    Parameters:
    
    collection - The collection to which the matching objects will be added (might be null)
    
    processor - The processor that decides whether or not an object must be added (must not be null)
    
    Returns:
    
    true if processing should continue, otherwise false
  - processResourceInformationObjects
```
public boolean processResourceInformationObjects(IResourceInformationProcessor processor)
```
    Calls the given processor for each contained resource info object in all containers.
    
    Parameters:
    
    processor - The processor that will be called for each contained resource object (must not be null).
    
    Returns:
    
    true if processing should continue, otherwise false.
  - processSpringBeans
```
public boolean processSpringBeans(ISpringBeanProcessor beanProcessor)
```
    Calls the given processor for each contained spring bean object in all containers.
    
    Parameters:
    
    beanProcessor - The processor that will be called for each contained spring bean object (must not be null).
    
    Returns:
    
    true if processing should continue, otherwise false.
  - addReleaseListener
```
public void addReleaseListener(org.pfsw.bif.lifecycle.IReleasable releasable)
```
    Add a listener that should be notified when this workset gets released. That enables the listener to clean-up its own resources before the workset gets fully released.
  - removeReleaseListener
```
public void removeReleaseListener(org.pfsw.bif.lifecycle.IReleasable releasable)
```
    Removes a formerly added listener for releasing resources.
  - getAnalyzableElementType
```
public AnalyzableElementType getAnalyzableElementType()
```
    Returns the type of the analyzable element.
    
    Specified by:
    
    getAnalyzableElementType in interface IAnalyzableElement
  - getName
```
public java.lang.String getName()
```
    Returns the name of this workset
    
    Specified by:
    
    getName in interface org.pfsw.odem.IExplorationModelObject
    
    Specified by:
    
    getName in class AModelObject
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description of this workset
    
    Specified by:
    
    getDescription in interface org.pfsw.odem.IExplorationContext
  - setDescription
```
public void setDescription(java.lang.String newValue)
```
    Sets the description of this workset
  - setClassSpaceAndFactory
```
public void setClassSpaceAndFactory(ClassSpace newValue)
```
  - getFollowIgnorePatterns
```
public StringFilterCollection getFollowIgnorePatterns()
```
    Return the filters that define which classes must not be analyzed
  - getViewFilters
```
public StringFilterCollection getViewFilters()
```
    Returns the filter collection that is defined to prevent classes from being displayed.
  - getClasspathParts
```
public java.util.List<ClasspathPartDefinition> getClasspathParts()
```
    Returns all the classpath element definitions that are specified for this workset
    
    Returns:
    
    A collection of ClasspathPartDefinition
  - getClasspathMetadata
```
public ClasspathMetadata getClasspathMetadata()
```
  - getVariablePool
```
public VariablePool getVariablePool()
```
  - getFilename
```
public java.lang.String getFilename()
```
    Returns the name of the file this workset was loaded from
  - setFilename
```
public void setFilename(java.lang.String newValue)
```
    Sets the filename this workset was stored under
  - isDirty
```
public boolean isDirty()
```
    Returns true, if the workset has been modified
  - getAutoReloadable
```
public java.lang.Boolean getAutoReloadable()
```
  - setAutoReloadable
```
public void setAutoReloadable(java.lang.Boolean newValue)
```
  - getShortContainerNames
```
public java.lang.Boolean getShortContainerNames()
```
  - getIncludeResourceFiles
```
public java.lang.Boolean getIncludeResourceFiles()
```
  - setIncludeResourceFiles
```
public void setIncludeResourceFiles(java.lang.Boolean includeResourceFiles)
```
  - getSpringBeanAnalysisEnabled
```
public java.lang.Boolean getSpringBeanAnalysisEnabled()
```
  - setSpringBeanAnalysisEnabled
```
public void setSpringBeanAnalysisEnabled(java.lang.Boolean springBeanAnalysisEnabled)
```
  - setShortContainerNames
```
public void setShortContainerNames(java.lang.Boolean newValue)
```
  - getComponentModel
```
public ComponentModel getComponentModel()
```
  - setComponentModel
```
public void setComponentModel(ComponentModel newValue)
```
  - getResolvedClassesCounter
```
public int getResolvedClassesCounter()
```
    Returns the internal counter for resolved classes.
  - isCalculatingHashesEnabled
```
public boolean isCalculatingHashesEnabled()
```
  - getCalculatingHashesEnabled
```
public java.lang.Boolean getCalculatingHashesEnabled()
```
  - setCalculatingHashesEnabled
```
public void setCalculatingHashesEnabled(java.lang.Boolean calculatingHashesEnabled)
```
  - initializationEvent
```
public void initializationEvent(IWorksetInitializationListener.EventType type,
                                Workset workset)
```
    Will be called for each event during workset initialization.
    
    Specified by:
    
    initializationEvent in interface IWorksetInitializationListener
  - refersTo
```
public boolean refersTo(IAnalyzableElement element)
```
    Returns always false
    
    Specified by:
    
    refersTo in interface IAnalyzableElement
    
    Parameters:
    
    element - The other element to check if this analyzable element directly refers to it
  - getContext
```
public org.pfsw.odem.IExplorationContext getContext()
```
    Returns this workset itself
    
    Specified by:
    
    getContext in interface org.pfsw.odem.IExplorationModelObject
  - accept
```
public boolean accept(org.pfsw.odem.IExplorableElementVisitor visitor)
```
    Implementation of the visitor pattern (GOF) for all derived interfaces if IExplorableElement.
    
    Specified by:
    
    accept in interface org.pfsw.odem.IExplorableElementVisiting
    
    Parameters:
    
    visitor - The implementor of the vistor interface to be called by this method
    
    Returns:
    
    true if processing should be continued, otherwise false
  - acceptTypes
```
public boolean acceptTypes(org.pfsw.odem.ITypesVisitor visitor)
```
    Implementation of the visitor pattern (GOF) for all derived interfaces if IExplorableElement. It iterates (recursively) over all contained IType objects and invokes the visitors callback method using the types as parameter.
    
    Specified by:
    
    acceptTypes in interface org.pfsw.odem.IExplorableElementVisiting
    
    Parameters:
    
    visitor - The implementor of the vistor interface to be called by this method
    
    Returns:
    
    true if processing should be continued, otherwise false
  - getChildCount
```
public int getChildCount()
```
    Returns the current number of children.
    
    Specified by:
    
    getChildCount in class AModelObject
  - getChildren
```
public AModelObject[] getChildren()
```
    Returns the children
    
    Specified by:
    
    getChildren in class AModelObject
    
    Returns:
    
    The children or an empty array (never null)
  - getWorkset
```
public Workset getWorkset()
```
    Returns this workset
    
    Specified by:
    
    getWorkset in interface IAnalyzableElement
    
    Specified by:
    
    getWorkset in class AModelObject
  - getComponents
```
public SoftwareComponent[] getComponents()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hasParent
```
protected boolean hasParent()
```
    Returns true if this object has a parent model object. Here it returns always false because a workset never has a parent.
    
    Specified by:
    
    hasParent in class AModelObject
  - getParent
```
protected AModelObject getParent()
```
    Returns the parent model object, which is always null for a workset.
    
    Specified by:
    
    getParent in class AModelObject
  - resetClassSpace
```
protected void resetClassSpace()
```
  - resetFollowIgnorePatterns
```
protected void resetFollowIgnorePatterns()
```
  - resetViewFilters
```
protected void resetViewFilters()
```
  - resetVariables
```
protected void resetVariables()
```
  - resetClasspathParts
```
protected void resetClasspathParts()
```
  - resetResolvedClasses
```
protected void resetResolvedClasses()
```
  - resetCache
```
protected void resetCache()
```
  - getClassInformationFactory
```
protected IClassInformationFactory getClassInformationFactory()
```
  - copyClasspathParts
```
protected java.util.List<ClasspathPartDefinition> copyClasspathParts()
```
  - initHighestClassFileVersion
```
protected void initHighestClassFileVersion()
```
  - initPhysicalContainers
```
protected void initPhysicalContainers()
```
    Iterate over all (physical) containers and initialize them from additional meta-data. For example set the "third-party" flag.
  - releasePhysicalContainers
```
protected void releasePhysicalContainers()
```
    Iterate over all physical containers and inform them that it is now okay to release any external resources (e.g. temp files) they might have.
  - isEqual
```
protected boolean isEqual(java.util.List<ClasspathPartDefinition> listA,
                          java.util.List<ClasspathPartDefinition> listB)
```
  - releaseReleasables
```
protected void releaseReleasables()
```
  - releaseContainers
```
protected void releaseContainers()
```
  - getReleaseListeners
```
protected java.util.List<org.pfsw.bif.lifecycle.IReleasable> getReleaseListeners()
```
  - inspectString
```
protected java.lang.String inspectString()
```
    Returns a string representation that is more convenient for object inspection with JOI.
  - coll
```
protected CollectionUtil coll()
```
    Overrides:
    
    coll in class AModelObject
  - setName
```
protected void setName(java.lang.String newValue)
```
  - getClassSpaceAndFactory
```
protected ClassSpace getClassSpaceAndFactory()
```
  - setFollowIgnorePatterns
```
protected void setFollowIgnorePatterns(StringFilterCollection newValue)
```
  - setViewFilters
```
protected void setViewFilters(StringFilterCollection newValue)
```
  - setClasspathParts
```
protected void setClasspathParts(java.util.List<ClasspathPartDefinition> newValue)
```
  - setClasspathMetadata
```
protected void setClasspathMetadata(ClasspathMetadata newValue)
```
  - getCache
```
protected StructuredCache getCache()
```
  - setCache
```
protected void setCache(StructuredCache newValue)
```
  - setVariablePool
```
protected void setVariablePool(VariablePool newValue)
```
  - isDirty
```
protected void isDirty(boolean newValue)
```
  - getInitState
```
protected org.pfsw.tools.cda.base.model.Workset.InitState getInitState()
```
  - setInitState
```
protected void setInitState(org.pfsw.tools.cda.base.model.Workset.InitState newValue)
```
  - getHighestClassFileVersion
```
protected ClassFileVersion getHighestClassFileVersion()
```
  - setHighestClassFileVersion
```
protected void setHighestClassFileVersion(ClassFileVersion newValue)
```
  - getPropertyChangeSupport
```
protected java.beans.PropertyChangeSupport getPropertyChangeSupport()
```
  - setPropertyChangeSupport
```
protected void setPropertyChangeSupport(java.beans.PropertyChangeSupport newValue)
```

Class Workset

Nested Class Summary

Nested classes/interfaces inherited from interface org.pfsw.tools.cda.base.model.workset.IWorksetInitializationListener

Field Summary

Fields inherited from class org.pfsw.tools.cda.base.model.AModelObject

Fields inherited from interface org.pfsw.tools.cda.base.model.IAnalyzableElement

Constructor Summary

Method Summary

Methods inherited from class org.pfsw.tools.cda.base.model.AModelObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.pfsw.odem.IObjectProperties

Field Detail

ATTR_DIRTY

Constructor Detail

Workset

Workset

Method Detail

addPropertyChangeListener

removePropertyChangeListener

getClassInfo

getClassSpace

followClass

addIgnoreFilter

addViewFilter

addClasspathPartDefinition

addClasspathPartDefinitions

getClassContainers

getContainers

getPhysicalClassContainers

getNotFoundClassesContainer

classpathDefinitions

getAllContainedClasses

storeInCache

findInCache

findClassInfos

findClassInfos

release

releaseForReInitialization

closeAllPhysicalContainers

areAllContainersInitialized

incResolvedClassesCounter

areAllDependenciesResolved

areAllClassesCollected

isAutoReloadable

isSpringAnalysisEnabled

isShortContainerNamesOn

isIncludeResourceFilesOn

canBeAnalyzedForDependencies

beClean

beDirty

modifyName

modifyDescription

modifyAutoReloadable

modifyShortContainerNames

modifyIncludeResourceFiles

modifySpringBeanAnalysisEnabled

modifyCalculatingHashesEnabled

modifyViewFilters

modifyIgnorePatterns

copy

updateFrom

isNew

getTimeForClassResolving

setGlobalVariables

getLocalVariables

setLocalVariables

getNumberOfContainedClasses

getNumberOfContainedPackages

getNumberOfClassContainers

getNumberOfContainedResources

getRequiredClassFileVersion

processClassInformationObjects

processClassInformationObjects

processClassPackageObjects

processClassPackageObjects

processClassContainersObjects

processClassContainersObjects

processSoftwareComponents

processResourceInformationObjects

processSpringBeans