OlogClientImpl (Olog API 2.2.7-SNAPSHOT API)

java.lang.Object
- edu.msu.nscl.olog.api.OlogClientImpl

All Implemented Interfaces:

OlogClient
```
public class OlogClientImpl
extends Object
implements OlogClient
```
Author:

Eric Berryman taken from shroffk

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OlogClientImpl.OlogClientBuilder
Builder Class to help create a olog client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OlogClientImpl.OlogClientBuilder` Builder Class to help create a olog client.

Method Summary

Methods
Modifier and Type	Method and Description
`Attachment`	`add(File local, Long logId)`
`void`	`delete(Collection<Log> logs)` Deprecated.
`void`	`delete(LogbookBuilder logbook, Collection<Long> logIds)` Remove the logbook `logbook` from the set of logs `logIds`
`void`	`delete(LogbookBuilder logbook, Long logId)` Remove logbook `logbook` from the log with name `logName`
`void`	`delete(LogBuilder log)` Remove the log identified by `log`
`void`	`delete(Long logId)` Remove the log identified by `log`
`void`	`delete(PropertyBuilder property, Collection<Long> logIds)` Remove the property `property` from the set of logs `logIds`
`void`	`delete(PropertyBuilder property, Long logId)` Remove property `property` from the log with id `logId` TODO: Should this be it's own service?
`void`	`delete(String fileName, Long logId)` Remove file attachment from log `logId TODO: sardine delete hangs up, using jersey for delete`
`void`	`delete(TagBuilder tag, Collection<Long> logIds)` Remove the tag `tag` from all the logs `logNames`
`void`	`delete(TagBuilder tag, Long logId)` Remove tag `tag` from the log with the id `logId`
`void`	`deleteLogbook(String logbook)`
`void`	`deleteProperty(String property)` Delete the property with name `property`
`void`	`deleteTag(String tag)` Remove {tag} from all logs
`Log`	`findLogById(Long logId)`
`Collection<Log>`	`findLogs(Map<String,String> map)` Query for logs based on the criteria specified in the map
`Collection<Log>`	`findLogs(javax.ws.rs.core.MultivaluedMap<String,String> map)` Multivalued map used to search for a key with multiple values.
`Collection<Log>`	`findLogsByLogbook(String logbook)` This function is a subset of queryLogs - should it be removed??
`Collection<Log>`	`findLogsByProperty(String propertyName)`
`Collection<Log>`	`findLogsByProperty(String propertyName, String attributeName, String attributeValue)` This function is a subset of queryLogs should it be removed??
`Collection<Log>`	`findLogsBySearch(String pattern)`
`Collection<Log>`	`findLogsByTag(String pattern)`
`InputStream`	`getAttachment(Long logId, Attachment attachment)`
`Log`	`getLog(Long logId)` Returns a log that exactly matches the logId `logId`
`Property`	`getProperty(String property)` return the complete property `property`
`Collection<Attachment>`	`listAttachments(Long logId)` Returns a collection of attachments that matches the logId `logId`
`Collection<String>`	`listAttributes(String propertyName)` List all the active attributes associated with the property `propertyName` property must exist, name != null
`Collection<Level>`	`listLevels()` Get a list of all the levels currently existing
`Collection<Logbook>`	`listLogbooks()` Get a list of all the logbooks currently existings
`Collection<Log>`	`listLogs()` Return all the logs.
`Collection<Property>`	`listProperties()` Get a list of all the Properties currently existing
`Collection<Tag>`	`listTags()` Get a list of all the tags currently existing
`Collection<Log>`	`set(Collection<LogBuilder> logs)` Set a set of logs Destructive operation.
`Logbook`	`set(LogbookBuilder logbook)` Set a new logbook `logbook` with no associated logs.
`Logbook`	`set(LogbookBuilder logbook, Collection<Long> logIds)` Set Logbook `logbook` to the logs `logIds` and remove it from all other logs TODO: all logids should exist, no nulls, check transaction
`Log`	`set(LogBuilder log)` Set a single log `log`, if the log already exists it is replaced.
`Property`	`set(PropertyBuilder property)` Create or replace property `property` TODO: test creation of a new property, test changing this property, test old log entries still have old property structure
`Tag`	`set(TagBuilder tag)` Set a Tag `tag` with no associated logs to the database.
`Tag`	`set(TagBuilder tag, Collection<Long> logIds)` Set tag `tag` on the set of logs `logIds` and remove it from all others TODO: all logIds should exist/ service should do proper transactions.
`Collection<Log>`	`update(Collection<LogBuilder> logs)` Update a set of logs
`Logbook`	`update(LogbookBuilder logbook, Collection<Long> logIds)` TODO: transaction check
`Logbook`	`update(LogbookBuilder logbook, Long logId)` Add Logbook `logbook` to the log `logId`
`Log`	`update(LogBuilder log)` Update a log entry `log`
`Property`	`update(PropertyBuilder property)` Update an existing property, TODO: check non destructive nature, old attributes should not be touched.
`Log`	`update(PropertyBuilder property, Long logId)` Update Property `property` by adding it to Log with id `logId` TODO : service invalid payload, need attribute and value
`Tag`	`update(TagBuilder tag, Collection<Long> logIds)` Update the Tag `tag` by adding it to the set of the logs with ids `logIds` TODO: Transactional nature,
`Tag`	`update(TagBuilder tag, Long logId)` Update Tag `tag` by adding it to Log with name `logName` TODO: logid valid.

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

- Method Detail
  - listLogbooks
```
public Collection<Logbook> listLogbooks()
                                 throws OlogException
```
    Description copied from interface: OlogClient
    
    Get a list of all the logbooks currently existings
    
    Specified by:
    
    listLogbooks in interface OlogClient
    
    Returns:
    string collection of logbooks
    
    Throws:
    
    OlogException
  - listTags
```
public Collection<Tag> listTags()
                         throws OlogException
```
    Description copied from interface: OlogClient
    
    Get a list of all the tags currently existing
    
    Specified by:
    
    listTags in interface OlogClient
    
    Returns:
    string collection of tags
    
    Throws:
    
    OlogException
  - listProperties
```
public Collection<Property> listProperties()
                                    throws OlogException
```
    Description copied from interface: OlogClient
    
    Get a list of all the Properties currently existing
    
    Specified by:
    
    listProperties in interface OlogClient
    
    Returns:
    
    Throws:
    
    OlogException
  - listAttributes
```
public Collection<String> listAttributes(String propertyName)
                                  throws OlogException
```
    Description copied from interface: OlogClient
    
    List all the active attributes associated with the property propertyName property must exist, name != null
    
    Specified by:
    
    listAttributes in interface OlogClient
    
    Returns:
    
    Throws:
    
    OlogException
  - listLevels
```
public Collection<Level> listLevels()
                             throws OlogException
```
    Description copied from interface: OlogClient
    
    Get a list of all the levels currently existing
    
    Specified by:
    
    listLevels in interface OlogClient
    
    Returns:
    string collection of levels
    
    Throws:
    
    OlogException
  - listLogs
```
public Collection<Log> listLogs()
```
    Description copied from interface: OlogClient
    
    Return all the logs. ***Warning can return a lot of data***
    
    Specified by:
    
    listLogs in interface OlogClient
    
    Returns:
    Collection of all log entires
  - getLog
```
public Log getLog(Long logId)
           throws OlogException
```
    Description copied from interface: OlogClient
    
    Returns a log that exactly matches the logId logId
    
    Specified by:
    
    getLog in interface OlogClient
    
    Parameters:
    logId - log id
    
    Returns:
    Log object
    
    Throws:
    
    OlogException
  - listAttachments
```
public Collection<Attachment> listAttachments(Long logId)
                                       throws OlogException
```
    Description copied from interface: OlogClient
    
    Returns a collection of attachments that matches the logId logId
    
    Specified by:
    
    listAttachments in interface OlogClient
    
    Parameters:
    logId - log id
    
    Returns:
    attachments collection object
    
    Throws:
    
    OlogException
  - getAttachment
```
public InputStream getAttachment(Long logId,
                        Attachment attachment)
```
    Specified by:
    
    getAttachment in interface OlogClient
  - getProperty
```
public Property getProperty(String property)
                     throws OlogException
```
    Description copied from interface: OlogClient
    
    return the complete property property
    
    Specified by:
    
    getProperty in interface OlogClient
    
    Returns:
    
    Throws:
    
    OlogException
  - set
```
public Log set(LogBuilder log)
        throws OlogException
```
    Description copied from interface: OlogClient
    
    Set a single log log, if the log already exists it is replaced. Destructive operation TODO: check validity of log entry represented by builder TODO: (shroffk) should there be anything returned? XXX: creating logs with same subject allowed?
    
    Specified by:
    
    set in interface OlogClient
    
    Parameters:
    log - the log to be added
    
    Throws:
    
    OlogException
  - set
```
public Collection<Log> set(Collection<LogBuilder> logs)
                    throws OlogException
```
    Description copied from interface: OlogClient
    
    Set a set of logs Destructive operation. TODO: (shroffk) should anything be returned? and should be returned from the service?
    
    Specified by:
    
    set in interface OlogClient
    
    Parameters:
    logs - collection of logs to be added
    
    Throws:
    
    OlogException
  - set
```
public Tag set(TagBuilder tag)
        throws OlogException
```
    Description copied from interface: OlogClient
    
    Set a Tag tag with no associated logs to the database. TODO: validity check,
    
    Specified by:
    
    set in interface OlogClient
    
    Throws:
    
    OlogException
  - set
```
public Tag set(TagBuilder tag,
      Collection<Long> logIds)
        throws OlogException
```
    Description copied from interface: OlogClient
    
    Set tag tag on the set of logs logIds and remove it from all others TODO: all logIds should exist/ service should do proper transactions.
    
    Specified by:
    
    set in interface OlogClient
    
    Throws:
    
    OlogException
  - set
```
public Logbook set(LogbookBuilder logbook)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Set a new logbook logbook with no associated logs.
    
    Specified by:
    
    set in interface OlogClient
    
    Throws:
    
    OlogException
  - set
```
public Logbook set(LogbookBuilder logbook,
          Collection<Long> logIds)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Set Logbook logbook to the logs logIds and remove it from all other logs TODO: all logids should exist, no nulls, check transaction
    
    Specified by:
    
    set in interface OlogClient
    
    Parameters:
    logbook - logbook builder
    logIds - log ids
    
    Throws:
    
    OlogException
  - set
```
public Property set(PropertyBuilder property)
```
    Description copied from interface: OlogClient
    
    Create or replace property property TODO: test creation of a new property, test changing this property, test old log entries still have old property structure
    
    Specified by:
    
    set in interface OlogClient
    
    Returns:
  - update
```
public Log update(LogBuilder log)
           throws OlogException
```
    Description copied from interface: OlogClient
    
    Update a log entry log
    
    Specified by:
    
    update in interface OlogClient
    
    Returns:
    the updated log entry
    
    Throws:
    
    OlogException
  - update
```
public Collection<Log> update(Collection<LogBuilder> logs)
                       throws OlogException
```
    Description copied from interface: OlogClient
    
    Update a set of logs
    
    Specified by:
    
    update in interface OlogClient
    
    Parameters:
    logs - set of logs to be added
    
    Throws:
    
    OlogException
  - update
```
public Property update(PropertyBuilder property)
                throws OlogException
```
    Description copied from interface: OlogClient
    
    Update an existing property, TODO: check non destructive nature, old attributes should not be touched. old entries should have old property.
    
    Specified by:
    
    update in interface OlogClient
    
    Returns:
    
    Throws:
    
    OlogException
  - update
```
public Tag update(TagBuilder tag,
         Long logId)
           throws OlogException
```
    Description copied from interface: OlogClient
    
    Update Tag tag by adding it to Log with name logName TODO: logid valid.
    
    Specified by:
    
    update in interface OlogClient
    
    Parameters:
    tag - tag builder
    logId - log id the tag to be added
    
    Throws:
    
    OlogException
  - update
```
public Tag update(TagBuilder tag,
         Collection<Long> logIds)
           throws OlogException
```
    Description copied from interface: OlogClient
    
    Update the Tag tag by adding it to the set of the logs with ids logIds TODO: Transactional nature,
    
    Specified by:
    
    update in interface OlogClient
    
    Parameters:
    tag - tag builder
    logIds - collection of log ids
    
    Throws:
    
    OlogException
  - update
```
public Logbook update(LogbookBuilder logbook,
             Long logId)
               throws OlogException
```
    Description copied from interface: OlogClient
    
    Add Logbook logbook to the log logId
    
    Specified by:
    
    update in interface OlogClient
    
    Parameters:
    logbook - logbook builder
    logId - log id
    
    Throws:
    
    OlogException
  - update
```
public Logbook update(LogbookBuilder logbook,
             Collection<Long> logIds)
               throws OlogException
```
    Description copied from interface: OlogClient
    
    TODO: transaction check
    
    Specified by:
    
    update in interface OlogClient
    
    Throws:
    
    OlogException
  - update
```
public Log update(PropertyBuilder property,
         Long logId)
           throws OlogException
```
    Description copied from interface: OlogClient
    
    Update Property property by adding it to Log with id logId TODO : service invalid payload, need attribute and value
    
    Specified by:
    
    update in interface OlogClient
    
    Parameters:
    property - property builder
    logId - log id the property to be added
    
    Throws:
    
    OlogException
  - add
```
public Attachment add(File local,
             Long logId)
               throws OlogException
```
    Specified by:
    
    add in interface OlogClient
    
    Throws:
    
    OlogException
  - findLogById
```
public Log findLogById(Long logId)
```
    Specified by:
    
    findLogById in interface OlogClient
    
    Returns:
  - findLogsBySearch
```
public Collection<Log> findLogsBySearch(String pattern)
                                 throws OlogException
```
    Specified by:
    
    findLogsBySearch in interface OlogClient
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - findLogsByTag
```
public Collection<Log> findLogsByTag(String pattern)
                              throws OlogException
```
    Specified by:
    
    findLogsByTag in interface OlogClient
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - findLogsByLogbook
```
public Collection<Log> findLogsByLogbook(String logbook)
                                  throws OlogException
```
    Description copied from interface: OlogClient
    
    This function is a subset of queryLogs - should it be removed??
    TODO: add the usage of patterns and implement on top of the general query using the map
    
    Specified by:
    
    findLogsByLogbook in interface OlogClient
    
    Parameters:
    logbook - logbook name
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - findLogsByProperty
```
public Collection<Log> findLogsByProperty(String propertyName)
                                   throws OlogException
```
    Specified by:
    
    findLogsByProperty in interface OlogClient
    
    Throws:
    
    OlogException
  - findLogsByProperty
```
public Collection<Log> findLogsByProperty(String propertyName,
                                 String attributeName,
                                 String attributeValue)
                                   throws OlogException
```
    Description copied from interface: OlogClient
    
    This function is a subset of queryLogs should it be removed??
    search for logs with property property and optionally value matching patternpropertyValue
    
    Specified by:
    
    findLogsByProperty in interface OlogClient
    
    Returns:
    
    Throws:
    
    OlogException
  - findLogs
```
public Collection<Log> findLogs(Map<String,String> map)
                         throws OlogException
```
    Description copied from interface: OlogClient
    
    Query for logs based on the criteria specified in the map
    
    Specified by:
    
    findLogs in interface OlogClient
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - findLogs
```
public Collection<Log> findLogs(javax.ws.rs.core.MultivaluedMap<String,String> map)
                         throws OlogException
```
    Description copied from interface: OlogClient
    
    Multivalued map used to search for a key with multiple values. e.g. logbook a=1 or logbook a=2
    
    Specified by:
    
    findLogs in interface OlogClient
    
    Parameters:
    map - Multivalue map for searching a key with multiple values
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - deleteTag
```
public void deleteTag(String tag)
               throws OlogException
```
    Description copied from interface: OlogClient
    
    Remove {tag} from all logs
    
    Specified by:
    
    deleteTag in interface OlogClient
    
    Throws:
    
    OlogException
  - deleteLogbook
```
public void deleteLogbook(String logbook)
                   throws OlogException
```
    Specified by:
    
    deleteLogbook in interface OlogClient
    
    Throws:
    
    OlogException
  - deleteProperty
```
public void deleteProperty(String property)
                    throws OlogException
```
    Description copied from interface: OlogClient
    
    Delete the property with name property
    
    Specified by:
    
    deleteProperty in interface OlogClient
    
    Throws:
    
    OlogException
  - delete
```
public void delete(LogBuilder log)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Remove the log identified by log
    
    Specified by:
    
    delete in interface OlogClient
    
    Parameters:
    log - log to be removed
    
    Throws:
    
    OlogException
  - delete
```
public void delete(Long logId)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Remove the log identified by log
    
    Specified by:
    
    delete in interface OlogClient
    
    Parameters:
    logId - log id log id to be removed
    
    Throws:
    
    OlogException
  - delete
```
@Deprecated
public void delete(Collection<Log> logs)
            throws OlogException
```
    Deprecated.
    
    Description copied from interface: OlogClient
    
    Remove the log collection identified by log
    
    Specified by:
    
    delete in interface OlogClient
    
    Parameters:
    logs - logs to be removed
    
    Throws:
    
    OlogException
  - delete
```
public void delete(TagBuilder tag,
          Long logId)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Remove tag tag from the log with the id logId
    
    Specified by:
    
    delete in interface OlogClient
    
    Throws:
    
    OlogException
  - delete
```
public void delete(TagBuilder tag,
          Collection<Long> logIds)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Remove the tag tag from all the logs logNames
    
    Specified by:
    
    delete in interface OlogClient
    
    Throws:
    
    OlogException
  - delete
```
public void delete(LogbookBuilder logbook,
          Long logId)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Remove logbook logbook from the log with name logName
    
    Specified by:
    
    delete in interface OlogClient
    
    Parameters:
    logbook - logbook builder
    logId - log id
    
    Throws:
    
    OlogException
  - delete
```
public void delete(LogbookBuilder logbook,
          Collection<Long> logIds)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Remove the logbook logbook from the set of logs logIds
    
    Specified by:
    
    delete in interface OlogClient
    
    Throws:
    
    OlogException
  - delete
```
public void delete(PropertyBuilder property,
          Long logId)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Remove property property from the log with id logId TODO: Should this be it's own service?
    
    Specified by:
    
    delete in interface OlogClient
    
    Parameters:
    property - property builder
    logId - log id
    
    Throws:
    
    OlogException
  - delete
```
public void delete(PropertyBuilder property,
          Collection<Long> logIds)
            throws OlogException
```
    Description copied from interface: OlogClient
    
    Remove the property property from the set of logs logIds
    
    Specified by:
    
    delete in interface OlogClient
    
    Throws:
    
    OlogException
  - delete
```
public void delete(String fileName,
          Long logId)
```
    Description copied from interface: OlogClient
    
    Remove file attachment from log logId TODO: sardine delete hangs up, using jersey for delete
    Specified by: delete in interface OlogClient

Class OlogClientImpl

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

listLogbooks

listTags

listProperties

listAttributes

listLevels

listLogs

getLog

listAttachments

getAttachment

getProperty

set

set

set

set

set

set

set

update

update

update

update

update

update

update

update

add

findLogById

findLogsBySearch

findLogsByTag

findLogsByLogbook

findLogsByProperty

findLogsByProperty

findLogs

findLogs

deleteTag

deleteLogbook

deleteProperty

delete

delete

delete

delete

delete

delete

delete

delete

delete

delete