gov.bnl.channelfinder.api

Class ChannelUtil

java.lang.Object

gov.bnl.channelfinder.api.ChannelUtil

public class ChannelUtil
extends Object

Author:

shroffk

Method Summary

Modifier and Type	Method and Description
static Collection<Channel>	filterbyElements(Collection<Channel> channels, Collection<String> propNames, Collection<String> tagNames) Given a Collection of channels returns a new collection of channels containing only those channels which have all the tags in the tagNames
static Collection<Channel>	filterbyProperties(Collection<Channel> channels, Collection<String> propNames) Given a Collection of channels returns a new collection of channels containing only those channels which have all the properties in the propNames
static Collection<Channel>	filterbyTags(Collection<Channel> channels, Collection<String> tagNames) Given a Collection of channels returns a new collection of channels containing only those channels which have all the tags in the tagNames
static Collection<String>	getAllTagNames(Collection<Channel> channels) Return a union of tag names associated with channels
static Collection<String>	getChannelNames(Collection<Channel> channels) Returns all the channel Names in the given Collection of channels
static Property	getProperty(Channel channel, String propertyName) Deprecated.
static Collection<String>	getPropertyNames(Channel channel) Return a list of property names associated with this channel
static Collection<String>	getPropertyNames(Collection<Channel> channels) Return a union of property names associated with channels
static Collection<String>	getPropValues(Collection<Channel> channels, String propertyName)
static Tag	getTag(Channel channel, String tagName) Deprecated.
static Collection<String>	getTagNames(Channel channel) Return a list of tag names associated with this channel
static Collection<Channel>	toChannels(Collection<Channel.Builder> channelBuilders) Returns a list of Channel built from the list of Channel.Builders
static List<XmlChannel>	toCollectionXmlChannels(Collection<Channel.Builder> channelBuilders) Returns a list of Channel built from the list of Channel.Builders

Methods inherited from class java.lang.Object

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

Method Detail

getTagNames

public static Collection<String> getTagNames(Channel channel)

Return a list of tag names associated with this channel

Parameters:

channel - - channel to be processed

Returns:

Collection of names of tags

getAllTagNames

public static Collection<String> getAllTagNames(Collection<Channel> channels)

Return a union of tag names associated with channels

Parameters:

channels - - list of channels

Returns:

a set of all unique tag names associated with atleast one or more channel in channels

getPropertyNames

public static Collection<String> getPropertyNames(Channel channel)

Return a list of property names associated with this channel

Parameters:

channel - - channel to be processed

Returns:

Collection of names of properties

getTag

@Deprecated
public static Tag getTag(Channel channel,
                                      String tagName)

Deprecated.

Deprecated - use channel.getTag instead Return the Tag object with name tagName if it exists on the channel channel else return null

Parameters:

channel - - channel

tagName - - tag name

Returns:

Tag - tag object found on channel

getProperty

@Deprecated
public static Property getProperty(Channel channel,
                                                String propertyName)

Deprecated.

deprecated - use the channel.getProperty instead Return the property object with the name propertyName if it exists on the channel channel else return null

Parameters:

channel - - channel

propertyName - - property name

Returns:

Property - property object found on channel

getPropertyNames

public static Collection<String> getPropertyNames(Collection<Channel> channels)

Return a union of property names associated with channels

Parameters:

channels - - list of channels

Returns:

a set of all unique property names associated with atleast one or more channel in channels

getPropValues

public static Collection<String> getPropValues(Collection<Channel> channels,
                                               String propertyName)

getChannelNames

public static Collection<String> getChannelNames(Collection<Channel> channels)

Returns all the channel Names in the given Collection of channels

Parameters:

channels - - list of channels

Returns:

a set of all the unique names associated with the each channel in channels

filterbyProperties

public static Collection<Channel> filterbyProperties(Collection<Channel> channels,
                                                     Collection<String> propNames)

Given a Collection of channels returns a new collection of channels containing only those channels which have all the properties in the propNames

Parameters:

channels - - the input list of channels

propNames - - the list of properties required on all channels

Returns:

Collection of Channels which contains all properties with propNames

filterbyTags

public static Collection<Channel> filterbyTags(Collection<Channel> channels,
                                               Collection<String> tagNames)

Given a Collection of channels returns a new collection of channels containing only those channels which have all the tags in the tagNames

Parameters:

channels - - the input list of channels

tagNames - - the list of tags required on all channels

Returns:

Collections of Channels which have all the tags within tagNames

filterbyElements

public static Collection<Channel> filterbyElements(Collection<Channel> channels,
                                                   Collection<String> propNames,
                                                   Collection<String> tagNames)

Given a Collection of channels returns a new collection of channels containing only those channels which have all the tags in the tagNames

Parameters:

channels - - the input list of channels

propNames - - the list of properties required on all channels

tagNames - - the list of tags required on all channels

Returns:

Collection of channels with all the properties and tags within propNames and tagNames

toChannels

public static Collection<Channel> toChannels(Collection<Channel.Builder> channelBuilders)

Returns a list of Channel built from the list of Channel.Builders

Parameters:

channelBuilders - - list of Channel.Builder to be built.

Returns:

Collection of Channel built from the channelBuilders

toCollectionXmlChannels

public static List<XmlChannel> toCollectionXmlChannels(Collection<Channel.Builder> channelBuilders)

Returns a list of Channel built from the list of Channel.Builders

Parameters:

channelBuilders - - list of Channel.Builder to be built.

Returns:

Collection of Channel built from the channelBuilders