Package org.ametys.plugins.extraction.execution

Class Extraction

java.lang.Object

org.ametys.plugins.extraction.execution.Extraction

public class Extraction
extends Object

Object representing the extraction definition file content

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Extraction.ExtractionProfile	Rights profiles
static enum	Extraction.Visibility	Visibility of a Query

Constructor Summary

Constructors

Constructor	Description
Extraction()

Method Summary

Modifier and Type	Method	Description
void	addExtractionComponent(ExtractionComponent extractionComponent)	Add an extraction component
boolean	canRead(UserIdentity user, GroupManager groupManager)	Determines if an user has READ access to this extraction.
boolean	canWrite(UserIdentity user, GroupManager groupManager)	Determines if an user has WRITE access to this extraction.
UserIdentity	getAuthor()	Get the author of the extraction
String	getDescriptionId()	Retrieves the identifier of the extraction's description
List<String>	getDisplayOptionalColumnsNames()	Retrieves the list of variables names controlling display of optional columns
List<ExtractionComponent>	getExtractionComponents()	Retrieves the list of the extraction components
Set<GroupIdentity>	getGrantedGroups(Extraction.ExtractionProfile profile)	Get the granted groups
Set<UserIdentity>	getGrantedUsers(Extraction.ExtractionProfile profile)	Get the granted users
Map<String,String>	getQueryVariablesNamesAndContentTypes()	Retrieves the list of variables names and content type to use in queries
Extraction.Visibility	getVisibility()	Get the visibility of the extraction
void	setAuthor(UserIdentity author)	Set the author of this extraction.
void	setDescriptionId(String descriptionId)	Set the identifier of the extraction's description
void	setDisplayOptionalColumnsNames(List<String> displayOptionalColumnsNames)	Set variables names controlling display of optional columns
void	setGrantedGroups(Extraction.ExtractionProfile profile, Set<GroupIdentity> groups)	Set the granted groups
void	setGrantedUsers(Extraction.ExtractionProfile profile, Set<UserIdentity> users)	Set the granted users
void	setQueryVariablesNamesAndContentTypes(Map<String,String> queryVariablesNamesAndContentTypes)	Set variables names and content types to use in queries
void	setVisibility(Extraction.Visibility visibility)	Set the extraction's visibility

Methods inherited from class java.lang.Object

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

Constructor Details

Extraction

public Extraction()

Method Details

getDescriptionId

public String getDescriptionId()

Retrieves the identifier of the extraction's description

Returns:

the identifier of the extraction's description

setDescriptionId

public void setDescriptionId(String descriptionId)

Set the identifier of the extraction's description

Parameters:

descriptionId - the identifier to set

getExtractionComponents

public List<ExtractionComponent> getExtractionComponents()

Retrieves the list of the extraction components

Returns:

The extraction components

addExtractionComponent

public void addExtractionComponent(ExtractionComponent extractionComponent)

Add an extraction component

Parameters:

extractionComponent - The extraction component to add

getDisplayOptionalColumnsNames

public List<String> getDisplayOptionalColumnsNames()

Retrieves the list of variables names controlling display of optional columns

Returns:

The variables names

setDisplayOptionalColumnsNames

public void setDisplayOptionalColumnsNames(List<String> displayOptionalColumnsNames)

Set variables names controlling display of optional columns

Parameters:

displayOptionalColumnsNames - the variables for the optional columns to set

getQueryVariablesNamesAndContentTypes

public Map<String,String> getQueryVariablesNamesAndContentTypes()

Retrieves the list of variables names and content type to use in queries

Returns:

A Map containing variables names and content types

setQueryVariablesNamesAndContentTypes

public void setQueryVariablesNamesAndContentTypes(Map<String,String> queryVariablesNamesAndContentTypes)

Set variables names and content types to use in queries

Parameters:

queryVariablesNamesAndContentTypes - A Map containing variables names and content types to set

getVisibility

public Extraction.Visibility getVisibility()

Get the visibility of the extraction

Returns:

The visibility

setVisibility

public void setVisibility(Extraction.Visibility visibility)

Set the extraction's visibility

Parameters:

visibility - the visibility

getAuthor

public UserIdentity getAuthor()

Get the author of the extraction

Returns:

The author

setAuthor

public void setAuthor(UserIdentity author)

Set the author of this extraction.

Parameters:

author - the author

getGrantedUsers

public Set<UserIdentity> getGrantedUsers(Extraction.ExtractionProfile profile)

Get the granted users

Parameters:

profile - the extraction profile

Returns:

the granted users

getGrantedGroups

public Set<GroupIdentity> getGrantedGroups(Extraction.ExtractionProfile profile)

Get the granted groups

Parameters:

profile - the extraction profile

Returns:

the granted groups

canRead

public boolean canRead(UserIdentity user,
 GroupManager groupManager)

Determines if an user has READ access to this extraction.

Parameters:

user - The user

groupManager - The group manager to determine the user's groups

Returns:

true if the user has read access, false otherwise

canWrite

public boolean canWrite(UserIdentity user,
 GroupManager groupManager)

Determines if an user has WRITE access to this extraction.

Parameters:

user - The user

groupManager - The group manager to determine the user's groups

Returns:

true if the user has write access, false otherwise

setGrantedUsers

public void setGrantedUsers(Extraction.ExtractionProfile profile,
 Set<UserIdentity> users)

Set the granted users

Parameters:

profile - the extraction profile

users - the granted users

setGrantedGroups

public void setGrantedGroups(Extraction.ExtractionProfile profile,
 Set<GroupIdentity> groups)

Set the granted groups

Parameters:

profile - the extraction profile

groups - the granted groups