Package com.ben12.reta.model

Class InputRequirementSource

java.lang.Object

com.ben12.reta.model.InputRequirementSource

All Implemented Interfaces:

com.ben12.reta.api.RequirementSourceManager

public class InputRequirementSource
extends Object
implements com.ben12.reta.api.RequirementSourceManager

Author:

Benoît Moreau (ben.12)

Property Summary

Properties

Type	Property	Description
javafx.beans.property.StringProperty	name

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COVERS	covers property name.
static final String	NAME	name property name.

Constructor Summary

Constructors

Constructor	Description
InputRequirementSource(String theName, com.ben12.reta.plugin.SourceProviderPlugin theProvider, com.ben12.reta.api.SourceConfiguration theConfiguration)

Method Summary

Modifier and Type	Method	Description
void	addReferenceAttribute(String att)
com.ben12.reta.api.Requirement	addRequirement(String summary, String id, String version, String content, Map<String,String> attributes)
void	addRequirementAttribute(String att)
void	clear()	Clear previous analysis results.
List<RequirementImpl>	getAllReferences()
List<RequirementImpl>	getAllUknownReferences()
com.ben12.reta.api.SourceConfiguration	getConfiguration()
List<InputRequirementSource>	getCovers()
Map<InputRequirementSource,Double>	getCoversBy()
String	getName()	Gets the value of the name property.
com.ben12.reta.plugin.SourceProviderPlugin	getProvider()
Set<String>	getReferenceAttributes()
Set<String>	getRequirementAttributes()
TreeSet<RequirementImpl>	getRequirements()
javafx.beans.property.StringProperty	nameProperty()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Details

name

public javafx.beans.property.StringProperty nameProperty

See Also:

• nameProperty()

Field Details

NAME

public static final String NAME

name property name.

See Also:

• Constant Field Values

COVERS

public static final String COVERS

covers property name.

See Also:

• Constant Field Values

Constructor Details

InputRequirementSource

public InputRequirementSource(String theName,
 com.ben12.reta.plugin.SourceProviderPlugin theProvider,
 com.ben12.reta.api.SourceConfiguration theConfiguration)

Parameters:

theName - document source name

theProvider - plug-in source provider

theConfiguration - plug-in source configuration

Method Details

clear

public void clear()

Clear previous analysis results.

nameProperty

public javafx.beans.property.StringProperty nameProperty()

Returns:

requirement source name property

getName

public String getName()

Gets the value of the name property.

Specified by:

getName in interface com.ben12.reta.api.RequirementSourceManager

Property description:

Source document name.

Returns:

the value of the name property

See Also:

• nameProperty()

getProvider

public com.ben12.reta.plugin.SourceProviderPlugin getProvider()

Returns:

the provider

getConfiguration

public com.ben12.reta.api.SourceConfiguration getConfiguration()

Returns:

the configuration

getRequirements

public TreeSet<RequirementImpl> getRequirements()

Returns:

the set of requirement found in the document

getAllReferences

public List<RequirementImpl> getAllReferences()

Returns:

the set of requirement found in the document

getAllUknownReferences

public List<RequirementImpl> getAllUknownReferences()

Returns:

the set of requirement found in the document

getCovers

public List<InputRequirementSource> getCovers()

Returns:

list of covered document sources by this document source

getCoversBy

public Map<InputRequirementSource,Double> getCoversBy()

Returns:

coverage rate of this document by the other documents

getRequirementAttributes

public Set<String> getRequirementAttributes()

Returns:

all requirement attributes set

addRequirementAttribute

public void addRequirementAttribute(String att)

Parameters:

att - requirement attribute name to add

getReferenceAttributes

public Set<String> getReferenceAttributes()

Returns:

all reference attributes set

addReferenceAttribute

public void addReferenceAttribute(String att)

Parameters:

att - reference attribute name to add

addRequirement

public com.ben12.reta.api.Requirement addRequirement(String summary,
 String id,
 String version,
 String content,
 Map<String,String> attributes)

Specified by:

addRequirement in interface com.ben12.reta.api.RequirementSourceManager

toString

public String toString()

Overrides:

toString in class Object