SoftwareExtractor

All Superinterfaces:: ConfigurableComponent

public interface SoftwareExtractor extends ConfigurableComponent

An extractor for general software artifacts.

Software extractor instances provide the functionality to execute the extraction process as well as access to the Software Artifact repository

Method Summary

Modifier and Type

Method

Description

List<ArtifactWrapper>

getSoftwareArtefacts()

Get a list of all extracted software artifacts.

ExtractionResult

runExtraction(String extractorId, HashMap<String,String> preferences)

Execute this software extractor

Methods inherited from interface org.somox.configuration.ConfigurableComponent
getConfigurationDefinitions

Method Details
- runExtraction
  
  ExtractionResult runExtraction(String extractorId, HashMap<String,String> preferences)
  
  Execute this software extractor
  
  Parameters:
  
  extractorId - The id of this extractor instance
  
  preferences - The preferences to run the extractor with
  
  Returns:
  
  The result of the extraction process
- getSoftwareArtefacts
  
  List<ArtifactWrapper> getSoftwareArtefacts()
  
  Get a list of all extracted software artifacts. The persistence is handled within the extractor component but is this method provides the required access
  Returns:
  
  A list of wrappers for the extracted artifacts.
  Depending on the concrete extraction this list may
  
  be empty,
  
  contain only the top level element or
  
  contain wrappers for all elements
  
  but will never be null.