ChannelFinderClientComp (ChannelFinder Client API 2.2.0 API)

java.lang.Object
- gov.bnl.channelfinder.api.ChannelFinderClientComp

All Implemented Interfaces:: ChannelFinderClient

public class ChannelFinderClientComp
extends Object
implements ChannelFinderClient

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` close
`void`	`delete(Collection<Channel.Builder> channels)` Delete the set of channels identified by `channels`
`void`	`delete(Property.Builder property, Collection<String> channelNames)` Remove the property `property` from the set of channels `channelNames`
`void`	`delete(Property.Builder property, String channelName)` Remove property `property` from the channel with name `channelName`
`void`	`delete(Tag.Builder tag, Collection<String> channelNames)` Remove the tag `tag` from all the channels `channelNames`
`void`	`delete(Tag.Builder tag, String channelName)` Delete tag `tag` from the channel with the name `channelName`
`void`	`deleteChannel(String channelName)` Delete the channel identified by `channel`
`void`	`deleteProperty(String propertyName)` Completely Delete property with name = propertyName from all channels and the channelfinder service.
`void`	`deleteTag(String tagName)` Completely Delete {tag} with name = tagName from all channels and the channelfinder service.
`Collection<Channel>`	`find(Map<String,String> map)` Query for channels based on the multiple criteria specified in the map.
`Collection<Channel>`	`find(javax.ws.rs.core.MultivaluedMap<String,String> map)` uery for channels based on the multiple criteria specified in the map.
`Collection<Channel>`	`find(String query)` Space seperated search criterias, patterns may include * and ? wildcards channelNamePattern propertyName=valuePattern1,valuePattern2 Tags=tagNamePattern Each criteria is logically ANDed, \|\| seperated values are logically ORed Query for channels based on the Query string `query` example: find("SR* Cell=1,2 Tags=GolderOrbit,myTag) this will return all channels with names starting with SR AND have property Cell=1 OR 2 AND have tags goldenOrbit AND myTag. IMP: each criteria is logically AND'ed while multiple values for Properties are OR'ed.
`Collection<Channel>`	`findByName(String pattern)` Search for channels who's name match the pattern `pattern`. The pattern can contain wildcard char * or ?.
`Collection<Channel>`	`findByProperty(String property, String... pattern)` Search for channels with properties who's Value match the pattern `pattern`. The pattern can contain wildcard char * or ?.
`Collection<Channel>`	`findByTag(String pattern)` Search for channels with tags who's name match the pattern `pattern`. The pattern can contain wildcard char * or ?.
`Collection<String>`	`getAllProperties()` Get a list of names of all the properties currently present on the channelfinder service.
`Collection<String>`	`getAllTags()` Get a list of names of all the tags currently present on the channelfinder service.
`Channel`	`getChannel(String channelName)` Returns a channel that exactly matches the channelName `channelName`.
`static ChannelFinderClientComp`	`getInstance()`
`void`	`set(Channel.Builder channel)` Destructively set a single channel `channel`, if the channel already exists it will be replaced with the given channel.
`void`	`set(Collection<Channel.Builder> channels)` Destructively set a set of channels, if any channels already exists it is replaced.
`void`	`set(Property.Builder property)` Destructively set a new property `property`.
`void`	`set(Property.Builder property, Collection<String> channelNames)` Destructively set property `prop` and add it to the channels `channelNames` removing it from all other channels.
`void`	`set(Property.Builder prop, Map<String,String> channelPropertyMap)` Destructively set the property `prop` and add it to the channels specified in the `channelPropertyMap`, where the map key is the channel name and the associated value is the property value to be used for that channel.
`void`	`set(Property.Builder property, String channelName)` Destructively set property `prop` and add it to the channel `channelName` and remove it from all others.
`void`	`set(Tag.Builder tag)` Destructively set a Tag `tag` with no associated channels to the database.
`void`	`set(Tag.Builder tag, Collection<String> channelNames)` Set tag `tag` on the set of channels {channels} and remove it from all others.
`void`	`set(Tag.Builder tag, String channelName)` Destructively set tag `tag` to channel `channelName` and remove the tag from all other channels.
`void`	`setReader(ChannelFinderClient reader)`
`void`	`setWriter(ChannelFinderClient writer)`
`void`	`update(Channel.Builder channel)` Update existing channel with `channel`.
`void`	`update(Property.Builder property, Collection<String> channelNames)` Update the channels identified with `channelNames` with the property `property`
`void`	`update(Property.Builder property, Map<String,String> channelPropValueMap)` Update the property `property` on all channels specified in the channelPropValueMap, where the key in the map is the channel name and the value is the value for that property
`void`	`update(Property.Builder property, String channelName)` Update Property `property` by adding it to the channel `channelName`, without affecting the other channels.
`void`	`update(Tag.Builder tag, Collection<String> channelNames)` Update the Tag `tag` by adding it to the set of the channels with names `channelNames`, without affecting the other instances of this tag.
`void`	`update(Tag.Builder tag, String channelName)` Update Tag `tag` by adding it to Channel with name `channelName`, without affecting the other instances of this tag.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static ChannelFinderClientComp getInstance()
```
  - setReader
```
public void setReader(ChannelFinderClient reader)
```
  - setWriter
```
public void setWriter(ChannelFinderClient writer)
```
  - getAllProperties
```
public Collection<String> getAllProperties()
```
    Description copied from interface: ChannelFinderClient
    
    Get a list of names of all the properties currently present on the channelfinder service.
    
    Specified by:
    
    getAllProperties in interface ChannelFinderClient
    
    Returns:
    list of names of all existing Propertys.
  - getAllTags
```
public Collection<String> getAllTags()
```
    Description copied from interface: ChannelFinderClient
    
    Get a list of names of all the tags currently present on the channelfinder service.
    
    Specified by:
    
    getAllTags in interface ChannelFinderClient
    
    Returns:
    a list of names of all the existing Tags.
  - getChannel
```
public Channel getChannel(String channelName)
                   throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Returns a channel that exactly matches the channelName channelName.
    
    Specified by:
    
    getChannel in interface ChannelFinderClient
    
    Parameters:
    channelName - - name of the required channel.
    
    Returns:
    Channel with name channelName or null
    
    Throws:
    
    ChannelFinderException
  - findByName
```
public Collection<Channel> findByName(String pattern)
                               throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Search for channels who's name match the pattern pattern.
    The pattern can contain wildcard char * or ?.
    
    Specified by:
    
    findByName in interface ChannelFinderClient
    
    Parameters:
    pattern - - the search pattern for the channel names
    
    Returns:
    A Collection of channels who's name match the pattern pattern
    
    Throws:
    
    ChannelFinderException
  - findByTag
```
public Collection<Channel> findByTag(String pattern)
                              throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Search for channels with tags who's name match the pattern pattern.
    The pattern can contain wildcard char * or ?.
    
    Specified by:
    
    findByTag in interface ChannelFinderClient
    
    Parameters:
    pattern - - the search pattern for the tag names
    
    Returns:
    A Collection of channels which contain tags who's name match the pattern pattern
    
    Throws:
    
    ChannelFinderException
  - findByProperty
```
public Collection<Channel> findByProperty(String property,
                                 String... pattern)
                                   throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Search for channels with properties who's Value match the pattern pattern.
    The pattern can contain wildcard char * or ?.
    
    Specified by:
    
    findByProperty in interface ChannelFinderClient
    
    Parameters:
    property - - the name of the property.
    pattern - - the seatch pattern for the property value.
    
    Returns:
    A collection of channels containing the property with name propertyName who's value matches the pattern pattern.
    
    Throws:
    
    ChannelFinderException
  - find
```
public Collection<Channel> find(String query)
                         throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Space seperated search criterias, patterns may include * and ? wildcards channelNamePattern propertyName=valuePattern1,valuePattern2 Tags=tagNamePattern Each criteria is logically ANDed, || seperated values are logically ORed Query for channels based on the Query string query example: find("SR* Cell=1,2 Tags=GolderOrbit,myTag)
    this will return all channels with names starting with SR AND have property Cell=1 OR 2 AND have tags goldenOrbit AND myTag.
    IMP: each criteria is logically AND'ed while multiple values for Properties are OR'ed.
    
    Specified by:
    
    find in interface ChannelFinderClient
    
    Returns:
    Collection of channels which satisfy the search criteria.
    
    Throws:
    
    ChannelFinderException
  - find
```
public Collection<Channel> find(Map<String,String> map)
                         throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Query for channels based on the multiple criteria specified in the map. Map.put("~name", "*")
    Map.put("~tag", "tag1")
    Map.put("Cell", "1,2,3") this will return all channels with name=any name AND tag=tag1 AND property Cell = 1 OR 2 OR 3.
    
    Specified by:
    
    find in interface ChannelFinderClient
    
    Returns:
    Collection of channels which satisfy the search map.
    
    Throws:
    
    ChannelFinderException
  - find
```
public Collection<Channel> find(javax.ws.rs.core.MultivaluedMap<String,String> map)
                         throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    uery for channels based on the multiple criteria specified in the map. Map.put("~name", "*")
    Map.put("~tag", "tag1")
    Map.put("Cell", "1")
    Map.put("Cell", "2")
    Map.put("Cell", "3")
    this will return all channels with name=any name AND tag=tag1 AND property Cell = 1 OR 2 OR 3.
    
    Specified by:
    
    find in interface ChannelFinderClient
    
    Parameters:
    map - - multivalued map of all search criteria
    
    Returns:
    Collection of channels which satisfy the search map.
    
    Throws:
    
    ChannelFinderException
  - set
```
public void set(Channel.Builder channel)
         throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Destructively set a single channel channel, if the channel already exists it will be replaced with the given channel.
    
    Specified by:
    
    set in interface ChannelFinderClient
    
    Parameters:
    channel - the channel to be added
    
    Throws:
    
    ChannelFinderException
  - set
```
public void set(Tag.Builder tag)
```
    Description copied from interface: ChannelFinderClient
    
    Destructively set a Tag tag with no associated channels to the database.
    
    Specified by:
    
    set in interface ChannelFinderClient
    
    Parameters:
    tag - - the tag to be set.
  - set
```
public void set(Property.Builder property)
         throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Destructively set a new property property.
    
    Specified by:
    
    set in interface ChannelFinderClient
    
    Parameters:
    property - - the property to be set.
    
    Throws:
    
    ChannelFinderException
  - set
```
public void set(Collection<Channel.Builder> channels)
         throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Destructively set a set of channels, if any channels already exists it is replaced.
    
    Specified by:
    
    set in interface ChannelFinderClient
    
    Parameters:
    channels - set of channels to be added
    
    Throws:
    
    ChannelFinderException
  - set
```
public void set(Tag.Builder tag,
       String channelName)
         throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Destructively set tag tag to channel channelName and remove the tag from all other channels.
    
    Specified by:
    
    set in interface ChannelFinderClient
    
    Parameters:
    tag - - the tag to be set.
    channelName - - the channel to which the tag should be set on.
    
    Throws:
    
    ChannelFinderException
  - set
```
public void set(Property.Builder property,
       String channelName)
```
    Description copied from interface: ChannelFinderClient
    
    Destructively set property prop and add it to the channel channelName and remove it from all others.
    
    Specified by:
    
    set in interface ChannelFinderClient
    
    Parameters:
    property - - property to be set.
    channelName - - the channel to which this property must be added.
  - set
```
public void set(Tag.Builder tag,
       Collection<String> channelNames)
         throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Set tag tag on the set of channels {channels} and remove it from all others.
    
    Specified by:
    
    set in interface ChannelFinderClient
    
    Parameters:
    tag - - the tag to be set.
    channelNames - - the list of channels to which this tag will be added and removed from all others.
    
    Throws:
    
    ChannelFinderException
  - set
```
public void set(Property.Builder property,
       Collection<String> channelNames)
```
    Description copied from interface: ChannelFinderClient
    
    Destructively set property prop and add it to the channels channelNames removing it from all other channels. By default all channels will contain the property with the same value specified in the prop.
    to individually set the value for each channel use channelPropertyMap.
    
    Specified by:
    
    set in interface ChannelFinderClient
    
    Parameters:
    property - - the property to be set.
    channelNames - - the channels to which this property should be added and removed from all others.
  - set
```
public void set(Property.Builder prop,
       Map<String,String> channelPropertyMap)
```
    Description copied from interface: ChannelFinderClient
    
    Destructively set the property prop and add it to the channels specified in the channelPropertyMap, where the map key is the channel name and the associated value is the property value to be used for that channel.
    
    Specified by:
    
    set in interface ChannelFinderClient
    
    Parameters:
    prop - - the property to be set.
    channelPropertyMap - - map with channel names and property values
  - update
```
public void update(Channel.Builder channel)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Update existing channel with channel.
    
    Specified by:
    
    update in interface ChannelFinderClient
    
    Throws:
    
    ChannelFinderException
  - update
```
public void update(Tag.Builder tag,
          String channelName)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Update Tag tag by adding it to Channel with name channelName, without affecting the other instances of this tag.
    
    Specified by:
    
    update in interface ChannelFinderClient
    
    Parameters:
    tag - the tag to be added
    channelName - Name of the channel to which the tag is to be added
    
    Throws:
    
    ChannelFinderException
  - update
```
public void update(Property.Builder property,
          String channelName)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Update Property property by adding it to the channel channelName, without affecting the other channels.
    
    Specified by:
    
    update in interface ChannelFinderClient
    
    Parameters:
    property - - the property to be updated
    channelName - - the channel to which this property should be added or updated.
    
    Throws:
    
    ChannelFinderException
  - update
```
public void update(Tag.Builder tag,
          Collection<String> channelNames)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Update the Tag tag by adding it to the set of the channels with names channelNames, without affecting the other instances of this tag.
    
    Specified by:
    
    update in interface ChannelFinderClient
    
    Parameters:
    tag - - the tag that needs to be updated.
    channelNames - - list of channels to which this tag should be added.
    
    Throws:
    
    ChannelFinderException
  - update
```
public void update(Property.Builder property,
          Collection<String> channelNames)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Update the channels identified with channelNames with the property property
    
    Specified by:
    
    update in interface ChannelFinderClient
    
    Throws:
    
    ChannelFinderException
  - update
```
public void update(Property.Builder property,
          Map<String,String> channelPropValueMap)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Update the property property on all channels specified in the channelPropValueMap, where the key in the map is the channel name and the value is the value for that property
    
    Specified by:
    
    update in interface ChannelFinderClient
    
    Throws:
    
    ChannelFinderException
  - deleteTag
```
public void deleteTag(String tagName)
               throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Completely Delete {tag} with name = tagName from all channels and the channelfinder service.
    
    Specified by:
    
    deleteTag in interface ChannelFinderClient
    
    Parameters:
    tagName - - name of tag to be deleted.
    
    Throws:
    
    ChannelFinderException
  - deleteProperty
```
public void deleteProperty(String propertyName)
                    throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Completely Delete property with name = propertyName from all channels and the channelfinder service.
    
    Specified by:
    
    deleteProperty in interface ChannelFinderClient
    
    Parameters:
    propertyName - - name of property to be deleted.
    
    Throws:
    
    ChannelFinderException
  - deleteChannel
```
public void deleteChannel(String channelName)
                   throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Delete the channel identified by channel
    
    Specified by:
    
    deleteChannel in interface ChannelFinderClient
    
    Parameters:
    channelName - channel to be removed
    
    Throws:
    
    ChannelFinderException
  - delete
```
public void delete(Collection<Channel.Builder> channels)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Delete the set of channels identified by channels
    
    Specified by:
    
    delete in interface ChannelFinderClient
    
    Throws:
    
    ChannelFinderException
  - delete
```
public void delete(Tag.Builder tag,
          String channelName)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Delete tag tag from the channel with the name channelName
    
    Specified by:
    
    delete in interface ChannelFinderClient
    
    Parameters:
    tag - - the tag to be deleted.
    channelName - - the channel from which to delete the tag tag
    
    Throws:
    
    ChannelFinderException
  - delete
```
public void delete(Property.Builder property,
          String channelName)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Remove property property from the channel with name channelName
    
    Specified by:
    
    delete in interface ChannelFinderClient
    
    Parameters:
    property - - the property to be deleted.
    channelName - - the channel from which to delete the property property
    
    Throws:
    
    ChannelFinderException
  - delete
```
public void delete(Tag.Builder tag,
          Collection<String> channelNames)
            throws ChannelFinderException
```
    Description copied from interface: ChannelFinderClient
    
    Remove the tag tag from all the channels channelNames
    
    Specified by:
    
    delete in interface ChannelFinderClient
    
    Parameters:
    tag - - the tag to be deleted.
    channelNames - - the channels from which to delete the tag tag
    
    Throws:
    
    ChannelFinderException
  - delete
```
public void delete(Property.Builder property,
          Collection<String> channelNames)
```
    Description copied from interface: ChannelFinderClient
    
    Remove the property property from the set of channels channelNames
    
    Specified by:
    
    delete in interface ChannelFinderClient
    
    Parameters:
    property - - the property to be deleted.
    channelNames - - the channels from which to delete the property property
  - close
```
public void close()
```
    Description copied from interface: ChannelFinderClient
    
    close
    
    Specified by:
    
    close in interface ChannelFinderClient

Class ChannelFinderClientComp

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

setReader

setWriter

getAllProperties

getAllTags

getChannel

findByName

findByTag

findByProperty

find

find

find

set

set

set

set

set

set

set

set

set

update

update

update

update

update

update

deleteTag

deleteProperty

deleteChannel

delete

delete

delete

delete

delete

close