sears.file
Class SsaSubtitle

java.lang.Object
  extended by sears.file.Subtitle
      extended by sears.file.SsaSubtitle
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable<Subtitle>

public class SsaSubtitle
extends Subtitle

this class represents a ssa subtitle.


Field Summary
static java.lang.String[] eventsDictionnaryKeys
          keys for 'events' section
 
Constructor Summary
SsaSubtitle(int subtitleNumber)
          Constructor
SsaSubtitle(Subtitle aSubtitle)
          Constructor Subtitle.
 
Method Summary
 void accentRemove()
          Method accentRemove.
 int compareTo(Subtitle subtitle)
           
 void delay(int delay)
          Method delay.
 int getEndDate()
          Method getEndDate.
 java.lang.String getEntrie(java.lang.String key)
          this method returns the value associated to a key in a dictionnary.
 int getStartDate()
          Method getStartDate.
 java.lang.String getSubtitle()
          Method getSubtitle.
 void htmlRemove()
          Method htmlRemove.
 boolean putEntrie(java.lang.String key, java.lang.String value)
          this method allows to change a value of a key.
 void setEndDate(int endDate)
          Method setEndDate.
 void setStartDate(int startDate)
          Method setStartDate.
 void setSubtitle(java.lang.String subtitle)
          Method setSubtitle.
 
Methods inherited from class sears.file.Subtitle
anchor, cloneSubtitle, equals, getAnchor, getNumber, isAnchored, setNumber, unanchor
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

eventsDictionnaryKeys

public static final java.lang.String[] eventsDictionnaryKeys
keys for 'events' section

Constructor Detail

SsaSubtitle

public SsaSubtitle(int subtitleNumber)
Constructor

Parameters:
subtitleNumber -

SsaSubtitle

public SsaSubtitle(Subtitle aSubtitle)
Constructor Subtitle. Copy another subtitle.

Parameters:
aSubtitle - The Subtitle to copy.
Method Detail

putEntrie

public boolean putEntrie(java.lang.String key,
                         java.lang.String value)
this method allows to change a value of a key. No add-on is possible, the key must be already exist...

Parameters:
key - the existing key
value - the value who wants to associated to the key
Returns:
true if the key exists, false if not

getEntrie

public java.lang.String getEntrie(java.lang.String key)
this method returns the value associated to a key in a dictionnary.

Parameters:
key - the existing key
Returns:
the associated value, if the value is null, null is returned.
There's no way to know if the key does not exist in the dictionnary

getEndDate

public int getEndDate()
Description copied from class: Subtitle
Method getEndDate.
Summary:
Return the endDate.

Overrides:
getEndDate in class Subtitle
Returns:
the endDate

setEndDate

public void setEndDate(int endDate)
Description copied from class: Subtitle
Method setEndDate.
Summary:
Set the endDate.

Overrides:
setEndDate in class Subtitle
Parameters:
endDate - the endDate to set

getStartDate

public int getStartDate()
Description copied from class: Subtitle
Method getStartDate.
Summary:
Return the startDate.

Overrides:
getStartDate in class Subtitle
Returns:
the startDate

setStartDate

public void setStartDate(int startDate)
Description copied from class: Subtitle
Method setStartDate.
Summary:
Set the startDate.

Overrides:
setStartDate in class Subtitle
Parameters:
startDate - the startDate to set

getSubtitle

public java.lang.String getSubtitle()
Description copied from class: Subtitle
Method getSubtitle.
Summary:
Return the subtitle.

Overrides:
getSubtitle in class Subtitle
Returns:
the subtitle

setSubtitle

public void setSubtitle(java.lang.String subtitle)
Description copied from class: Subtitle
Method setSubtitle.
Summary:
Set the subtitle.

Overrides:
setSubtitle in class Subtitle
Parameters:
subtitle - the subtitle to set

delay

public void delay(int delay)
Description copied from class: Subtitle
Method delay.
Summary:
Apply a delay to the subtitle.

Overrides:
delay in class Subtitle
Parameters:
delay - The delay to apply.

accentRemove

public void accentRemove()
Description copied from class: Subtitle
Method accentRemove.
Summary:
This method remove the accents and other bad characters from subtitle.

Overrides:
accentRemove in class Subtitle

htmlRemove

public void htmlRemove()
Description copied from class: Subtitle
Method htmlRemove.
Summary:
This method remove the Html tags from subtitle.

Overrides:
htmlRemove in class Subtitle

compareTo

public int compareTo(Subtitle subtitle)
Specified by:
compareTo in interface java.lang.Comparable<Subtitle>
Overrides:
compareTo in class Subtitle