|
TV-Browser 3.3.3 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object devplugin.Channel
public class Channel
A class that defines a TV-Browser channel
Field Summary | |
---|---|
static int |
CATEGORY_CINEMA
The identifier for a channel that is in the category cinema |
static int |
CATEGORY_DIGITAL
The identifier for a channel that is in the category digital |
static int |
CATEGORY_EVENTS
The identifier for a channel that is in the category events |
static int |
CATEGORY_NONE
The identifier for a channel that fits in no other category |
static int |
CATEGORY_PAY_TV
The identifier for a channel that is in the category pay TV |
static int |
CATEGORY_PAYED_DATA_TV
The identifier for a channel that is in the category payed data TV |
static int |
CATEGORY_RADIO
The identifier for a channel that is in the category radio |
static int |
CATEGORY_SPECIAL_MUSIC
The identifier for a channel that is in the category music |
static int |
CATEGORY_SPECIAL_NEWS
The identifier for a channel that is in the category news |
static int |
CATEGORY_SPECIAL_OTHER
The identifier for a channel that is in the category other |
static int |
CATEGORY_SPECIAL_SPORT
The identifier for a channel that is in the category sport |
static int |
CATEGORY_TV
The identifier for a channel that is in the category TV |
Constructor Summary | |
---|---|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String country)
Deprecated. |
|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String country,
java.lang.String copyrightNotice)
Creates an instance of this class. |
|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String country,
java.lang.String copyrightNotice,
java.lang.String webpage)
Creates an instance of this class. |
|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String country,
java.lang.String copyrightNotice,
java.lang.String webpage,
ChannelGroup group)
Creates an instance of this class. |
|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String country,
java.lang.String copyrightNotice,
java.lang.String webpage,
ChannelGroup group,
javax.swing.Icon icon)
Creates an instance of this class. |
|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String country,
java.lang.String copyrightNotice,
java.lang.String webpage,
ChannelGroup group,
javax.swing.Icon icon,
int categories)
Creates an instance of this class. |
|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String country,
java.lang.String copyrightNotice,
java.lang.String webpage,
ChannelGroup group,
javax.swing.Icon icon,
int categories,
java.lang.String unescapedName)
Creates an instance of this class. |
|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String baseCountry,
java.lang.String copyrightNotice,
java.lang.String webpage,
ChannelGroup group,
javax.swing.Icon icon,
int categories,
java.lang.String unescapedName,
java.lang.String[] allCountries)
Creates an instance of this class. |
|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String baseCountry,
java.lang.String copyrightNotice,
java.lang.String webpage,
ChannelGroup group,
javax.swing.Icon icon,
int categories,
java.lang.String unescapedName,
java.lang.String[] allCountries,
java.lang.String sharedChannelId)
Creates an instance of this class. |
|
Channel(AbstractTvDataService dataService,
java.lang.String name,
java.util.TimeZone timeZone,
java.lang.String country,
java.lang.String copyrightNotice)
Creates an instance of this class. |
|
Channel(java.lang.String id,
java.lang.String country)
Creates an instance of this class. |
|
Channel(java.lang.String name,
java.lang.String id,
java.lang.String country)
Creates an instance of this class. |
|
Channel(java.lang.String id,
java.util.TimeZone timeZone,
java.lang.String country)
Creates an instance of this class. |
Method Summary | |
---|---|
int |
compareTo(Channel other)
|
boolean |
equals(java.lang.Object obj)
|
java.lang.String[] |
getAllCountries()
|
Channel |
getBaseChannel()
Gets the base channel of this channel. |
java.lang.String |
getBaseCountry()
Gets the base country of this channel. |
int |
getCategories()
Gets the categories of this channel. |
static Channel |
getChannel(java.lang.String dataServiceId,
java.lang.String groupId,
java.lang.String country,
java.lang.String channelId)
|
static Channel |
getChannelForChannel(Channel ch)
Gets the base channel for the given channel if joined or returns the channel. |
java.lang.String |
getCopyrightNotice()
Gets the copyright notice for this channel. |
java.lang.String |
getCountriesString()
Gets the countries String for this channel. |
java.lang.String |
getCountry()
Deprecated. since 3.2.1 use getBaseCountry() instead. |
AbstractTvDataService |
getDataService()
Deprecated. use getDataServiceProxy() instead |
java.lang.String |
getDataServicePackageName()
|
TvDataServiceProxy |
getDataServiceProxy()
Gets the data service proxy of this channel |
int |
getDayLightSavingTimeCorrection()
Deprecated. since 3.0 |
javax.swing.Icon |
getDefaultIcon()
Return the Default-Icon |
java.lang.String |
getDefaultName()
Get the default ChannelName |
java.lang.String |
getDefaultWebPage()
Get the Default WebPage |
int |
getEndTimeLimit()
Gets the end time limit in minutes of day. |
ChannelGroup |
getGroup()
Gets the channel group of this channel. |
javax.swing.Icon |
getIcon()
|
java.lang.String |
getId()
Gets the id of this channel. |
Channel |
getJointChannel()
Gets the joint channel of this channel. |
javax.swing.Icon |
getJointChannelIcon()
Gets the joint channel icon of this channel |
java.lang.String |
getJointChannelName()
Gets the joint channel name of this channel |
static java.lang.String |
getLocalizedCategory(int category)
get the localized name of the given category |
java.lang.String |
getName()
Gets the name of this channel. |
java.lang.String |
getSharedChannelId()
Gets the shared channel id for this channel. |
int |
getStartTimeLimit()
Gets the start time limit in minutes of day. |
java.util.TimeZone |
getTimeZone()
Gets the time zone of this channel. |
int |
getTimeZoneCorrectionMinutes()
Gets the time zone offset of this channel. |
java.lang.String |
getUnescapedName()
Gets the unescaped name of this channel. |
java.lang.String |
getUniqueId()
Gets a unique identifier of this channel. |
java.lang.String |
getUserChannelName()
Get the ChannelName used by the User |
java.lang.String |
getUserIconFileName()
|
java.lang.String |
getUserWebPage()
Get the WebPage used by the User |
java.lang.String |
getWebpage()
Gets the webpage for this channel. |
boolean |
hasIcon()
Gets if this channel has an icon. |
boolean |
isTimeLimited()
Gets if this channel is limited in start and end time. |
boolean |
isUsingUserIcon()
Is using the User-Icon if availabe? |
static Channel |
readData(java.io.DataInput in,
boolean allowNull)
Method for OnDemandDayProgramFile file format version 2. |
static Channel |
readData(java.io.ObjectInputStream in,
boolean allowNull)
Creates an instance of this class from a stream. |
void |
setChannelCopyrightNotice(java.lang.String copyrightNotice)
Sets the copyright notice of this channel. |
void |
setChannelName(java.lang.String name)
Sets the name of this channel. |
void |
setChannelWebpage(java.lang.String webpage)
Sets the webpage of this channel. |
void |
setDayLightSavingTimeCorrection(int hours)
Deprecated. since 3.0 |
void |
setDefaultIcon(javax.swing.Icon icon)
Sets the Default-Icon. |
void |
setEndTimeLimit(int endTimeLimit)
Sets the end time limit to the new value. |
void |
setIcon(javax.swing.Icon icon)
|
void |
setJointChannel(Channel ch)
Sets the joint channel of this channel. |
void |
setStartTimeLimit(int startTimeLimit)
Sets the start time limit to the new value. |
void |
setTimeZoneCorrectionMinutes(int minutes)
Corrects the time zone offset of the channel. |
void |
setUserChannelName(java.lang.String name)
Set the ChannelName used by the User |
void |
setUserIconFileName(java.lang.String filename)
Sets the user icon file name. |
void |
setUserWebPage(java.lang.String url)
Set the WebPage used by the User |
java.lang.String |
toString()
|
void |
useUserIcon(boolean use)
Use the User-Icon if available? |
void |
writeData(java.io.ObjectOutputStream out)
Serialized this object. |
void |
writeToDataFile(java.io.RandomAccessFile out)
Method for OnDemandDayProgramFile file format version 2. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int CATEGORY_NONE
public static final int CATEGORY_TV
public static final int CATEGORY_RADIO
public static final int CATEGORY_CINEMA
public static final int CATEGORY_EVENTS
public static final int CATEGORY_DIGITAL
public static final int CATEGORY_SPECIAL_MUSIC
public static final int CATEGORY_SPECIAL_SPORT
public static final int CATEGORY_SPECIAL_NEWS
public static final int CATEGORY_SPECIAL_OTHER
public static final int CATEGORY_PAY_TV
public static final int CATEGORY_PAYED_DATA_TV
Constructor Detail |
---|
public Channel(AbstractTvDataService dataService, java.lang.String name, java.lang.String id, java.util.TimeZone timeZone, java.lang.String baseCountry, java.lang.String copyrightNotice, java.lang.String webpage, ChannelGroup group, javax.swing.Icon icon, int categories, java.lang.String unescapedName, java.lang.String[] allCountries, java.lang.String sharedChannelId)
dataService
- The data service of this channel.name
- The name of this channel.id
- The id of this channel.timeZone
- The time zone of this channel.baseCountry
- The base country of this channel.copyrightNotice
- The copyright notice for this channel.webpage
- The webpage of this channel.group
- The group of this channel.icon
- The icon for this channel.categories
- The categories for this channel.unescapedName
- The unescaped name for this channel.allCountries
- All supported countries of this channel.
ATTENTION: Have to contain the base country too.sharedChannelId
- The id of the shared channel.public Channel(AbstractTvDataService dataService, java.lang.String name, java.lang.String id, java.util.TimeZone timeZone, java.lang.String baseCountry, java.lang.String copyrightNotice, java.lang.String webpage, ChannelGroup group, javax.swing.Icon icon, int categories, java.lang.String unescapedName, java.lang.String[] allCountries)
dataService
- The data service of this channel.name
- The name of this channel.id
- The id of this channel.timeZone
- The time zone of this channel.baseCountry
- The base country of this channel.copyrightNotice
- The copyright notice for this channel.webpage
- The webpage of this channel.group
- The group of this channel.icon
- The icon for this channel.categories
- The categories for this channel.unescapedName
- The unescaped name for this channel.allCountries
- All supported countries of this channel.
ATTENTION: Have to contain the base country too.public Channel(AbstractTvDataService dataService, java.lang.String name, java.lang.String id, java.util.TimeZone timeZone, java.lang.String country, java.lang.String copyrightNotice, java.lang.String webpage, ChannelGroup group, javax.swing.Icon icon, int categories, java.lang.String unescapedName)
dataService
- The data service of this channel.name
- The name of this channel.id
- The id of this channel.timeZone
- The time zone of this channel.country
- The base country of this channel.copyrightNotice
- The copyright notice for this channel.webpage
- The webpage of this channel.group
- The group of this channel.icon
- The icon for this channel.categories
- The categories for this channel.unescapedName
- The unescaped name for this channel.public Channel(AbstractTvDataService dataService, java.lang.String name, java.lang.String id, java.util.TimeZone timeZone, java.lang.String country, java.lang.String copyrightNotice, java.lang.String webpage, ChannelGroup group, javax.swing.Icon icon, int categories)
dataService
- The data service of this channel.name
- The name of this channel.id
- The id of this channel.timeZone
- The time zone of this channel.country
- The base country of this channel.copyrightNotice
- The copyright notice for this channel.webpage
- The webpage of this channel.group
- The group of this channel.icon
- The icon for this channel.categories
- The categories for this channel.public Channel(AbstractTvDataService dataService, java.lang.String name, java.lang.String id, java.util.TimeZone timeZone, java.lang.String country, java.lang.String copyrightNotice, java.lang.String webpage, ChannelGroup group, javax.swing.Icon icon)
dataService
- The data service of this channel.name
- The name of this channel.id
- The id of this channel.timeZone
- The time zone of this channel.country
- The base country of this channel.copyrightNotice
- The copyright notice for this channel.webpage
- The webpage of this channel.group
- The group of this channel.icon
- The icon for this channel.public Channel(AbstractTvDataService dataService, java.lang.String name, java.lang.String id, java.util.TimeZone timeZone, java.lang.String country, java.lang.String copyrightNotice, java.lang.String webpage, ChannelGroup group)
dataService
- The data service of this channel.name
- The name of this channel.id
- The id of this channel.timeZone
- The time zone of this channel.country
- The base country of this channel.copyrightNotice
- The copyright notice for this channel.webpage
- The webpage of this channel.group
- The group of this channel.public Channel(AbstractTvDataService dataService, java.lang.String name, java.lang.String id, java.util.TimeZone timeZone, java.lang.String country, java.lang.String copyrightNotice, java.lang.String webpage)
dataService
- The data service of this channel.name
- The name of this channel.id
- The id of this channel.timeZone
- The time zone of this channel.country
- The base country of this channel.copyrightNotice
- The copyright notice for this channel.webpage
- The webpage of this channel.public Channel(AbstractTvDataService dataService, java.lang.String name, java.lang.String id, java.util.TimeZone timeZone, java.lang.String country, java.lang.String copyrightNotice)
dataService
- The data service of this channel.name
- The name of this channel.id
- The id of this channel.timeZone
- The time zone of this channel.country
- The base country of this channel.copyrightNotice
- The copyright notice for this channel.public Channel(AbstractTvDataService dataService, java.lang.String name, java.util.TimeZone timeZone, java.lang.String country, java.lang.String copyrightNotice)
dataService
- The data service of this channel.name
- The name of this channel.timeZone
- The time zone of this channel.country
- The base country of this channel.copyrightNotice
- The copyright notice for this channel.@Deprecated public Channel(AbstractTvDataService dataService, java.lang.String name, java.lang.String id, java.util.TimeZone timeZone, java.lang.String country)
dataService
- The data service of this channel.name
- The name of this channel.id
- The id of this channel.timeZone
- The time zone of this channel.country
- The base country of this channel.public Channel(java.lang.String id, java.util.TimeZone timeZone, java.lang.String country)
id
- The id of this channel.timeZone
- The time zone of this channel.country
- The base country of this channel.public Channel(java.lang.String name, java.lang.String id, java.lang.String country)
name
- The name of this channel.id
- The id of this channel.country
- The base country of this channel.public Channel(java.lang.String id, java.lang.String country)
id
- The id of this channel.country
- The base country of this channel.Method Detail |
---|
public static Channel readData(java.io.ObjectInputStream in, boolean allowNull) throws java.io.IOException, java.lang.ClassNotFoundException
in
- The stream to load the data from.allowNull
- True
if the method is allowed to return null
.
null
if allowNull
is true
and the channel could not be load.
java.io.IOException
java.lang.ClassNotFoundException
public static Channel readData(java.io.DataInput in, boolean allowNull) throws java.io.IOException, java.lang.ClassNotFoundException
in
- The file too read the Data from.allowNull
-
java.io.IOException
java.lang.ClassNotFoundException
public void writeToDataFile(java.io.RandomAccessFile out) throws java.io.IOException
out
- The file to write the Data in.
java.io.IOException
public void writeData(java.io.ObjectOutputStream out) throws java.io.IOException
out
- The stream to write the values of this channel to.
java.io.IOException
public java.lang.String getCopyrightNotice()
public java.lang.String getWebpage()
public ChannelGroup getGroup()
public int getCategories()
public static Channel getChannel(java.lang.String dataServiceId, java.lang.String groupId, java.lang.String country, java.lang.String channelId)
dataServiceId
- The id of the data service of the channel to get.groupId
- The group id of the channel to get.country
- The country of the channel to get.channelId
- The id of the channel to get.
null
if no channel with the ids was found.public java.util.TimeZone getTimeZone()
public java.lang.String getCountry()
getBaseCountry()
instead.
public java.lang.String getBaseCountry()
public java.lang.String[] getAllCountries()
@Deprecated public void setDayLightSavingTimeCorrection(int hours)
hours
- The new day light saving time correction.public void setTimeZoneCorrectionMinutes(int minutes)
minutes
- The offset in minutes. Valid values are only half or full hours (positive and negative).@Deprecated public int getDayLightSavingTimeCorrection()
public int getTimeZoneCorrectionMinutes()
@Deprecated public AbstractTvDataService getDataService()
public TvDataServiceProxy getDataServiceProxy()
public void setDefaultIcon(javax.swing.Icon icon)
icon
- Default-Iconpublic void setIcon(javax.swing.Icon icon)
icon
- The new icon or null to remove the current iconpublic java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getName()
public java.lang.String getId()
public javax.swing.Icon getIcon()
public boolean hasIcon()
True
if this channel has an icon,
false
otherwise.public void setUserIconFileName(java.lang.String filename)
filename
- The file name of the user icon file.public java.lang.String getUserIconFileName()
public void useUserIcon(boolean use)
use
- true for using User-Iconpublic boolean isUsingUserIcon()
public javax.swing.Icon getDefaultIcon()
public void setUserChannelName(java.lang.String name)
name
- new ChannelNamepublic java.lang.String getUserChannelName()
public java.lang.String getDefaultName()
public void setUserWebPage(java.lang.String url)
url
- WebPagepublic java.lang.String getUserWebPage()
public java.lang.String getDefaultWebPage()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public boolean isTimeLimited()
True
if this channel is time limited.public int getStartTimeLimit()
public void setStartTimeLimit(int startTimeLimit)
startTimeLimit
- The new value for start time
limit in minutes of day.public int getEndTimeLimit()
public void setEndTimeLimit(int endTimeLimit)
endTimeLimit
- The new value for end time
limit in minutes of day.public int compareTo(Channel other)
compareTo
in interface java.lang.Comparable<Channel>
public void setChannelName(java.lang.String name)
name
- The new name for the channel.public void setChannelCopyrightNotice(java.lang.String copyrightNotice)
copyrightNotice
- The new copyright notice for the channel.public void setChannelWebpage(java.lang.String webpage)
webpage
- The new webpage for the channel.public java.lang.String getUnescapedName()
public java.lang.String getUniqueId()
public static java.lang.String getLocalizedCategory(int category)
category
- category bit, see Channel.CATEGORY_XYZ
public java.lang.String getDataServicePackageName()
public java.lang.String getCountriesString()
public void setJointChannel(Channel ch)
ch
- The joint channel or null
if there is no joint channel.public java.lang.String getJointChannelName()
null
if there is no joint channel name.public javax.swing.Icon getJointChannelIcon()
null
if there is no joint channel icon.public Channel getJointChannel()
null
if there is no joint channel.public Channel getBaseChannel()
null
if there is no base channel.public java.lang.String getSharedChannelId()
null
if there is none.public static Channel getChannelForChannel(Channel ch)
ch
- The channel to check.
|
TV-Browser 3.3.3 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |