Profile

java.lang.Object
- model.Profile

```
public class Profile
extends java.lang.Object
```
A Profile is a data structure that contains a list of files (Part) and a list of configured AbstractModules to be used on these files. Furthermore a Environment instance is contained, to keep the results of the profiles file-independent extraction modules. Each profile has a final UUID to be identified and a changeable name which is shown at the user interfaces.

Constructor Summary

Constructors
Constructor and Description
`Profile(ProfileController profileController, java.lang.String uuID)` Profile constructor, if no name is given.
`Profile(ProfileController profileController, java.lang.String name, java.lang.String uuID)` Profile constructor to create a Profile with a specific name

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAllModules(java.util.List<AbstractModule> modules)` Adds all `AbstractModule`s of a list to this profile.
`void`	`addAllPartsFromPaths(java.util.HashSet<java.nio.file.Path> paths, boolean extract)` All all files defines by a Path set to the profile.
`void`	`addModule(AbstractModule module)` Adds an `AbstractModule` to this profile.
`void`	`addPart(Part part)` Add a `Part` to this Profile.
`void`	`addPart(Part part, boolean async)` Add a `Part` to this Profile.
`void`	`cleanupParts()` Removes all `Part`s from this Profile, that refer to non-existing files.
`void`	`deleteAllMetadata()` Deletes all extracted information.
`void`	`exportAsTemplate()` Exports the profile as `ProfileTemplate`: The list of configured `AbstractModule`s survives, and the name of the Profile.
`Environment`	`getEnvironment()` Returns the `Environment` of this Profile
`java.util.HashSet<AbstractModule>`	`getModules()` Returns all `AbstractModule`s contained in this Profile.
`java.lang.String`	`getName()` Returns the current name of this Profile
`java.lang.String`	`getOutputDirectory()` Returns a string path to the output directory of this profile.
`java.util.HashSet<Part>`	`getParts()` Returns all `Part`s belonging to this profile.
`protected java.util.HashSet<Part>`	`getPartsFromDirectoryFiles(java.io.File directory)` Loads all saved `Part`s from a specific directory.
`java.lang.String`	`getUUID()` Returns the UUID of this Profile
`boolean`	`isEnabled()` Returns if the extraction will be started for this Profile.
`protected void`	`loadModules()` Loads the `AbstractModule`s belonging to this Profile.
`protected void`	`loadParts()` Loads the `Part`s belonging to this Profile.
`protected void`	`loadProperties()` Loads the Profiles settings
`void`	`removeAllModules()` Removes all `AbstractModule`s from this profile.
`void`	`removeAllParts()` Removes all `Part`s from this profile.
`void`	`removeModule(AbstractModule module)` Removes a specific `AbstractModule` from this profile.
`void`	`removePart(Part part)` Remove a specific `Part` from this profile.s
`void`	`save()` Saves the complete Profile during application shutdown.
`void`	`setEnabled(boolean enable)` Enables or disables the extraction of this Profile.
`void`	`setName(java.lang.String newName)` Changes the name of this Profile
`void`	`startAllDaemons()` Starts all daemon modules of this profile.
`void`	`stopAllDaemons()` Stops all daemon modules of this profile.
`java.lang.String`	`toString()` Overrides toString() and returns profiles name.

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

- Constructor Detail
  - Profile
```
public Profile(ProfileController profileController,
               java.lang.String uuID)
```
    Profile constructor, if no name is given.
    
    Parameters:
    
    profileController - The applications ProfileController
    
    uuID - Has to be created by ProfileController
  - Profile
```
public Profile(ProfileController profileController,
               java.lang.String name,
               java.lang.String uuID)
```
    Profile constructor to create a Profile with a specific name
    
    Parameters:
    
    profileController - The applications ProfileController
    
    name - The name of the Profile to be shown at the user interfaces
    
    uuID - The identifier of the Profile
- Method Detail
  - loadProperties
```
protected void loadProperties()
```
    Loads the Profiles settings
  - loadModules
```
protected void loadModules()
```
    Loads the AbstractModules belonging to this Profile.
  - loadParts
```
protected void loadParts()
```
    Loads the Parts belonging to this Profile.
  - save
```
public void save()
```
    Saves the complete Profile during application shutdown.
  - setName
```
public void setName(java.lang.String newName)
```
    Changes the name of this Profile
    
    Parameters:
    
    newName - new name string
  - getName
```
public java.lang.String getName()
```
    Returns the current name of this Profile
    
    Returns:
    
    current Profiles name
  - getUUID
```
public java.lang.String getUUID()
```
    Returns the UUID of this Profile
    
    Returns:
    
    UUID of this Profile
  - getEnvironment
```
public Environment getEnvironment()
```
    Returns the Environment of this Profile
    
    Returns:
    
    the environment of this profile
  - cleanupParts
```
public void cleanupParts()
```
    Removes all Parts from this Profile, that refer to non-existing files.
  - getParts
```
public java.util.HashSet<Part> getParts()
```
    Returns all Parts belonging to this profile.
    
    Returns:
    
    HashSet of all Parts contained in this Profile.
  - getOutputDirectory
```
public java.lang.String getOutputDirectory()
```
    Returns a string path to the output directory of this profile.
    
    Returns:
    
    output directory paths
  - getModules
```
public java.util.HashSet<AbstractModule> getModules()
```
    Returns all AbstractModules contained in this Profile.
    
    Returns:
    
    HashSet of all profiles AbstractModules
  - addPart
```
public void addPart(Part part)
```
    Add a Part to this Profile.
    
    Parameters:
    
    part -
  - addPart
```
public void addPart(Part part,
                    boolean async)
```
    Add a Part to this Profile. An initial extraction will be started for this part, which can be asynchronous or synchronous.
    
    Parameters:
    
    part - Part to be added
    
    async - Indicates whether the initial extraction run should be asynchronous.
  - removePart
```
public void removePart(Part part)
```
    Remove a specific Part from this profile.s
    
    Parameters:
    
    part - Part to be removed.
  - removeAllParts
```
public void removeAllParts()
```
    Removes all Parts from this profile.
  - addAllModules
```
public void addAllModules(java.util.List<AbstractModule> modules)
```
    Adds all AbstractModules of a list to this profile.
    
    Parameters:
    
    modules -
  - addModule
```
public void addModule(AbstractModule module)
```
    Adds an AbstractModule to this profile.
    
    Parameters:
    
    module - AbstractModule to be added.
  - removeAllModules
```
public void removeAllModules()
```
    Removes all AbstractModules from this profile.
  - removeModule
```
public void removeModule(AbstractModule module)
```
    Removes a specific AbstractModule from this profile.
    
    Parameters:
    
    module -
  - stopAllDaemons
```
public void stopAllDaemons()
```
    Stops all daemon modules of this profile.
  - startAllDaemons
```
public void startAllDaemons()
```
    Starts all daemon modules of this profile.
  - toString
```
public java.lang.String toString()
```
    Overrides toString() and returns profiles name.
    
    Overrides:
    
    toString in class java.lang.Object
  - deleteAllMetadata
```
public void deleteAllMetadata()
```
    Deletes all extracted information.
  - addAllPartsFromPaths
```
public void addAllPartsFromPaths(java.util.HashSet<java.nio.file.Path> paths,
                                 boolean extract)
```
    All all files defines by a Path set to the profile.
    
    Parameters:
    
    paths - Paths to the files that should be added.
  - getPartsFromDirectoryFiles
```
protected java.util.HashSet<Part> getPartsFromDirectoryFiles(java.io.File directory)
```
    Loads all saved Parts from a specific directory.
    
    Parameters:
    
    directory - Path of the directory to load the Parts from.
    
    Returns:
    
    List of all loaded Parts
  - isEnabled
```
public boolean isEnabled()
```
    Returns if the extraction will be started for this Profile.
    
    Returns:
    
    true if extraction is enabled
  - setEnabled
```
public void setEnabled(boolean enable)
```
    Enables or disables the extraction of this Profile.
    
    Parameters:
    
    enable - Enables the extraction if true.
  - exportAsTemplate
```
public void exportAsTemplate()
```
    Exports the profile as ProfileTemplate: The list of configured AbstractModules survives, and the name of the Profile.

Class Profile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Profile

Profile

Method Detail

loadProperties

loadModules

loadParts

save

setName

getName

getUUID

getEnvironment

cleanupParts

getParts

getOutputDirectory

getModules

addPart

addPart

removePart

removeAllParts

addAllModules

addModule

removeAllModules

removeModule

stopAllDaemons

startAllDaemons

toString

deleteAllMetadata

addAllPartsFromPaths

getPartsFromDirectoryFiles

isEnabled

setEnabled

exportAsTemplate