Class FilteredSession

java.lang.Object

ca.phon.app.session.FilteredSession

All Implemented Interfaces:

SessionSPI

public class FilteredSession
extends Object
implements SessionSPI

Constructor Summary

Constructors

Constructor	Description
FilteredSession(Session session, RecordFilter filter)

Method Summary

Modifier and Type	Method	Description
void	addParticipant(int idx, Participant participant)	Add participant at given index
void	addParticipant(Participant participant)	Add a new participant
void	addTranscriber(Transcriber t)	Add a new transcriber
void	addUserTier(int idx, TierDescription tierDescription)
void	addUserTier(TierDescription tierDescription)	Add a user tier
void	deleteTierAlignmentRules(String tier1, String tier2)
List<String>	getBlindTiers()	Get list of blind tier names
String	getCorpus()	Get the corpus
LocalDate	getDate()	Get the transcript date
Session	getDelegate()
RecordFilter	getFilter()
List<Language>	getLanguages()	Get the list of (unmodifiable) languages (if any) for the session
String	getMediaLocation()	Get/Set the media file location
Map<String,String>	getMetadata()	Get the metadata
String	getName()	Get the transcript name
Participant	getParticipant(int idx)	Get the participant at the given index
int	getParticipantCount()	Get the number of participants
int	getParticipantIndex(Participant participant)	Get the index of the given participant
Map<String,String>	getSystemTierParameters(SystemTierType systemTier)	Get tier parameters for system tier
List<TierAlignmentRules>	getTierAlignmentRules()
TierAlignmentRules	getTierAlignmentRules(String tier1, String tier2)
List<TierDescription>	getTiers()	Get list of all tiers including system tiers
List<TierViewItem>	getTierView()	Get the tier view
IntervalTiers	getTimeline()	Get the timeline object which is the collection of all timeline tiers.
Transcriber	getTranscriber(int i)	Get the ith transcriber.
Transcriber	getTranscriber(String username)	Get transcriber for the specified username
int	getTranscriberCount()	Get the number of transcribers
Transcript	getTranscript()	Get the transcript object which is the collection of all comments, gems and records.
TierDescription	getUserTier(int idx)	Get user tier for the specified index.
int	getUserTierCount()	Number of user-defined tiers for this session
void	putSystemTierParam(SystemTierType systemTier, String key, String value)	Set tier parameter for system tier
void	putTierAlignmentRules(TierAlignmentRules tierAlignmentRules)
void	removeParticipant(int idx)	Remove a participant
void	removeParticipant(Participant participant)	Remove a participant.
void	removeTranscriber(int i)	Remove the ith transcriber
void	removeTranscriber(Transcriber t)	Remove a transcriber
void	removeTranscriber(String username)
TierDescription	removeUserTier(int idx)	Remove user tier
TierDescription	removeUserTier(TierDescription tierDescription)
void	setBlindTiers(List<String> blindTiers)	Set list of blind tier names
void	setCorpus(String corpus)	Set the corpus
void	setDate(LocalDate date)	Get the transcript date
void	setLanguages(List<Language> languages)	Set the list of languages for the session
void	setMediaLocation(String mediaLocation)	Media location
void	setName(String name)	Set the transcript name
void	setTierView(List<TierViewItem> view)	Set tier view

Methods inherited from class java.lang.Object

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

Constructor Details

FilteredSession

public FilteredSession(Session session,
 RecordFilter filter)

Method Details

getName

public String getName()

Description copied from interface: SessionSPI

Get the transcript name

Specified by:

getName in interface SessionSPI

getDate

public LocalDate getDate()

Description copied from interface: SessionSPI

Get the transcript date

Specified by:

getDate in interface SessionSPI

getLanguages

public List<Language> getLanguages()

Description copied from interface: SessionSPI

Get the list of (unmodifiable) languages (if any) for the session

Specified by:

getLanguages in interface SessionSPI

setLanguages

public void setLanguages(List<Language> languages)

Description copied from interface: SessionSPI

Set the list of languages for the session

Specified by:

setLanguages in interface SessionSPI

Parameters:

languages -

getMediaLocation

public String getMediaLocation()

Description copied from interface: SessionSPI

Get/Set the media file location

Specified by:

getMediaLocation in interface SessionSPI

getTierView

public List<TierViewItem> getTierView()

Description copied from interface: SessionSPI

Get the tier view

Specified by:

getTierView in interface SessionSPI

Returns:

tier view (unmodifiable)

setTierView

public void setTierView(List<TierViewItem> view)

Description copied from interface: SessionSPI

Set tier view

Specified by:

setTierView in interface SessionSPI

Parameters:

view -

getTiers

public List<TierDescription> getTiers()

Description copied from interface: SessionSPI

Get list of all tiers including system tiers

Specified by:

getTiers in interface SessionSPI

Returns:

list of all tiers including system tiers and user defined tiers

getSystemTierParameters

public Map<String,String> getSystemTierParameters(SystemTierType systemTier)

Description copied from interface: SessionSPI

Get tier parameters for system tier

Specified by:

getSystemTierParameters in interface SessionSPI

Parameters:

systemTier -

Returns:

unmodifiable tier params for given system tier

putSystemTierParam

public void putSystemTierParam(SystemTierType systemTier,
 String key,
 String value)

Description copied from interface: SessionSPI

Set tier parameter for system tier

Specified by:

putSystemTierParam in interface SessionSPI

Parameters:

systemTier -

key -

value -

getUserTierCount

public int getUserTierCount()

Description copied from interface: SessionSPI

Number of user-defined tiers for this session

Specified by:

getUserTierCount in interface SessionSPI

getUserTier

public TierDescription getUserTier(int idx)

Description copied from interface: SessionSPI

Get user tier for the specified index.

Specified by:

getUserTier in interface SessionSPI

Parameters:

idx -

Returns:

tier description

removeUserTier

public TierDescription removeUserTier(int idx)

Description copied from interface: SessionSPI

Remove user tier

Specified by:

removeUserTier in interface SessionSPI

Parameters:

idx -

removeUserTier

public TierDescription removeUserTier(TierDescription tierDescription)

Specified by:

removeUserTier in interface SessionSPI

addUserTier

public void addUserTier(TierDescription tierDescription)

Description copied from interface: SessionSPI

Add a user tier

Specified by:

addUserTier in interface SessionSPI

addUserTier

public void addUserTier(int idx,
 TierDescription tierDescription)

Specified by:

addUserTier in interface SessionSPI

getTierAlignmentRules

public List<TierAlignmentRules> getTierAlignmentRules()

Specified by:

getTierAlignmentRules in interface SessionSPI

getTierAlignmentRules

public TierAlignmentRules getTierAlignmentRules(String tier1,
 String tier2)

Specified by:

getTierAlignmentRules in interface SessionSPI

putTierAlignmentRules

public void putTierAlignmentRules(TierAlignmentRules tierAlignmentRules)

Specified by:

putTierAlignmentRules in interface SessionSPI

deleteTierAlignmentRules

public void deleteTierAlignmentRules(String tier1,
 String tier2)

Specified by:

deleteTierAlignmentRules in interface SessionSPI

getBlindTiers

public List<String> getBlindTiers()

Description copied from interface: SessionSPI

Get list of blind tier names

Specified by:

getBlindTiers in interface SessionSPI

Returns:

blind tier names

setBlindTiers

public void setBlindTiers(List<String> blindTiers)

Description copied from interface: SessionSPI

Set list of blind tier names

Specified by:

setBlindTiers in interface SessionSPI

getTranscriberCount

public int getTranscriberCount()

Description copied from interface: SessionSPI

Get the number of transcribers

Specified by:

getTranscriberCount in interface SessionSPI

getTranscriber

public Transcriber getTranscriber(String username)

Description copied from interface: SessionSPI

Get transcriber for the specified username

Specified by:

getTranscriber in interface SessionSPI

Parameters:

username -

Returns:

getTranscriber

public Transcriber getTranscriber(int i)

Description copied from interface: SessionSPI

Get the ith transcriber.

Specified by:

getTranscriber in interface SessionSPI

Parameters:

i -

Returns:

removeTranscriber

public void removeTranscriber(int i)

Description copied from interface: SessionSPI

Remove the ith transcriber

Specified by:

removeTranscriber in interface SessionSPI

Parameters:

i -

getMetadata

public Map<String,String> getMetadata()

Description copied from interface: SessionSPI

Get the metadata

Specified by:

getMetadata in interface SessionSPI

Returns:

Metadata

getParticipantCount

public int getParticipantCount()

Description copied from interface: SessionSPI

Get the number of participants

Specified by:

getParticipantCount in interface SessionSPI

Returns:

the number of participants

addParticipant

public void addParticipant(Participant participant)

Description copied from interface: SessionSPI

Add a new participant

Specified by:

addParticipant in interface SessionSPI

Parameters:

participant -

addParticipant

public void addParticipant(int idx,
 Participant participant)

Description copied from interface: SessionSPI

Add participant at given index

Specified by:

addParticipant in interface SessionSPI

Parameters:

idx -

participant -

getParticipant

public Participant getParticipant(int idx)

Description copied from interface: SessionSPI

Get the participant at the given index

Specified by:

getParticipant in interface SessionSPI

Parameters:

idx -

Returns:

the specified participant

getParticipantIndex

public int getParticipantIndex(Participant participant)

Description copied from interface: SessionSPI

Get the index of the given participant

Specified by:

getParticipantIndex in interface SessionSPI

Returns:

index of participant or -1 if not found

setName

public void setName(String name)

Description copied from interface: SessionSPI

Set the transcript name

Specified by:

setName in interface SessionSPI

setDate

public void setDate(LocalDate date)

Description copied from interface: SessionSPI

Get the transcript date

Specified by:

setDate in interface SessionSPI

setMediaLocation

public void setMediaLocation(String mediaLocation)

Description copied from interface: SessionSPI

Media location

Specified by:

setMediaLocation in interface SessionSPI

addTranscriber

public void addTranscriber(Transcriber t)

Description copied from interface: SessionSPI

Add a new transcriber

Specified by:

addTranscriber in interface SessionSPI

removeTranscriber

public void removeTranscriber(Transcriber t)

Description copied from interface: SessionSPI

Remove a transcriber

Specified by:

removeTranscriber in interface SessionSPI

removeTranscriber

public void removeTranscriber(String username)

Specified by:

removeTranscriber in interface SessionSPI

removeParticipant

public void removeParticipant(Participant participant)

Description copied from interface: SessionSPI

Remove a participant.

Specified by:

removeParticipant in interface SessionSPI

Parameters:

participant -

removeParticipant

public void removeParticipant(int idx)

Description copied from interface: SessionSPI

Remove a participant

Specified by:

removeParticipant in interface SessionSPI

Parameters:

idx -

getTranscript

public Transcript getTranscript()

Description copied from interface: SessionSPI

Get the transcript object which is the collection of all comments, gems and records.

Specified by:

getTranscript in interface SessionSPI

Returns:

transcript object

getTimeline

public IntervalTiers getTimeline()

Description copied from interface: SessionSPI

Get the timeline object which is the collection of all timeline tiers.

Specified by:

getTimeline in interface SessionSPI

Returns:

timeline object

getCorpus

public String getCorpus()

Description copied from interface: SessionSPI

Get the corpus

Specified by:

getCorpus in interface SessionSPI

setCorpus

public void setCorpus(String corpus)

Description copied from interface: SessionSPI

Set the corpus

Specified by:

setCorpus in interface SessionSPI

getFilter

public RecordFilter getFilter()

getDelegate

public Session getDelegate()