This repository has been archived by the owner on May 7, 2020. It is now read-only.
Initial commit of persistence extensions #1872
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /** | ||
| * Copyright (c) 2014-2016 by the respective copyright holders. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| */ | ||
| package org.eclipse.smarthome.core.persistence; | ||
|
|
||
| import java.security.InvalidParameterException; | ||
| import java.util.Date; | ||
|
|
||
| import org.eclipse.smarthome.core.items.Item; | ||
| import org.eclipse.smarthome.core.types.State; | ||
|
|
||
| /** | ||
| * This class provides an interface to the a {@link PersistenceService} to allow data to be stored | ||
| * at a specific time. This allows bindings that interface to devices that store data internally, | ||
| * and then periodically provide it to the server to be accommodated. | ||
| * | ||
| * @author Chris Jackson - Initial implementation and API | ||
| * | ||
| */ | ||
| public interface ModifiablePersistenceService extends QueryablePersistenceService { | ||
| /** | ||
| * <p> | ||
| * Stores the historic item value. This allows the item, time and value to be specified. | ||
| * </p> | ||
| * <p> | ||
| * Adding data with the same time as an existing record should update the current record value rather than adding a | ||
| * new record. | ||
| * </p> | ||
| * <p> | ||
| * Implementors should keep in mind that all registered {@link PersistenceService}s are called synchronously. Hence | ||
| * long running operations should be processed asynchronously. E.g. <code>store</code> adds things to a queue which | ||
| * is processed by some asynchronous workers (Quartz Job, Thread, etc.). | ||
| * </p> | ||
| * | ||
| * @param item the data to be stored | ||
| * @param date the date of the record | ||
| * @param state the state to be recorded | ||
| */ | ||
| void store(Item item, Date date, State state); | ||
|
|
||
| /** | ||
| * Removes data associated with an item from a persistence service. | ||
| * If all data is removed for the specified item, the persistence service should free any resources associated with | ||
|
There was a problem hiding this comment. Please update the javadoc - the filtercriteria might not filter for a specific item at all, so this method is applicable for many items at the same time as well. There was a problem hiding this comment. I'm not sure I follow. I assumed that there must be an item name provided - it's not possible to add a filter with multiple item names, and I think it would be dangerous to add a filter with no item name. As discussed elsewhere, in the REST interface at least, it is required. Technically it would be possible to implement a filter that removed data from multiple items, but is it a good idea? There was a problem hiding this comment. Well, if you look at FilterCriteria, it reads: So in general, it allows that the itemName is null and hence the filter is applicable for ANY item. As your method accepts a filter criteria as a parameter, you have to deal with that fact. If you do not want to allow itemName to be null, you should document this in the JavaDoc and declare an exception that you will throw in that case. |
||
| * the item (eg. remove any tables or delete files from the storage). | ||
| * | ||
| * @param filter the filter to apply to the data removal. ItemName can not be null. | ||
| * @return true if the query executed successfully | ||
| * @throws {@link InvalidParameterException} if item name is null. | ||
|
There was a problem hiding this comment. Err, no: "This exception, designed for use by the JCA/JCE engine classes". |
||
| */ | ||
| boolean remove(FilterCriteria filter) throws InvalidParameterException; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /** | ||
| * Copyright (c) 2014-2016 by the respective copyright holders. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| */ | ||
| package org.eclipse.smarthome.core.persistence; | ||
|
|
||
| import java.util.Date; | ||
|
|
||
| /** | ||
| * This class provides information about an item that is stored in a persistence service. | ||
| * It is used to return information about the item to the system | ||
| * | ||
| * @author Chris Jackson - Initial contribution | ||
| * | ||
| */ | ||
| public interface PersistenceItemInfo { | ||
| /** | ||
| * Returns the item name. | ||
| * It should be noted that the item name is as stored in the persistence service and as such may not be linked to an | ||
| * item. This may be the case if the item was removed from the system, but data still exists in the persistence | ||
| * service. | ||
| * | ||
| * @return Item name | ||
| */ | ||
| String getName(); | ||
|
|
||
| /** | ||
| * Returns a counter with the number of rows of data associated with the item | ||
| * Note that this should be used as a guide to the amount of data and may note be 100% accurate. If accurate | ||
| * information is required, the {@link QueryablePersistenceService#query} method should be used. | ||
| * | ||
| * @return count of the number of rows of data. May return null if the persistence service doesn't support this. | ||
| */ | ||
| Integer getCount(); | ||
|
|
||
| /** | ||
| * Returns the earliest timestamp from data in the persistence database | ||
| * | ||
| * @return the earliest {@link Date} stored in the database. May return null if the persistence service doesn't | ||
| * support this. | ||
| */ | ||
| Date getEarliest(); | ||
|
|
||
| /** | ||
| * Returns the latest timestamp from data in the persistence database | ||
| * | ||
| * @return the latest {@link Date} stored in the database. May return null if the persistence service doesn't | ||
| * support this. | ||
| */ | ||
| Date getLatest(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /** | ||
| * Copyright (c) 2014-2016 by the respective copyright holders. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| */ | ||
| package org.eclipse.smarthome.core.persistence.dto; | ||
|
|
||
| /** | ||
| * This is a java bean that is used to serialize information about items in a persistence service to JSON. | ||
| * | ||
| * @author Chris Jackson - Initial Contribution | ||
| * | ||
| */ | ||
| public class PersistenceItemInfoBean { | ||
|
There was a problem hiding this comment. Call it DTO, not Bean. So did you come to the conclusion that you definitely need it? There was a problem hiding this comment. No - it shouldn't be used any more. I thought I'd deleted it but maybe I didn't commit it. Anyway, it's not needed. Sent from my iPhone
|
||
| PersistenceItemInfoBean() { | ||
| } | ||
|
|
||
| /** | ||
| * The name of the item in the persistence service | ||
| */ | ||
| public String name; | ||
|
|
||
| /** | ||
| * A count of the number of rows of data in the persistence store for the item | ||
| */ | ||
| public Integer count; | ||
|
|
||
| /** | ||
| * The earliest time for the data stored in the database | ||
| */ | ||
| public String earliest; | ||
|
|
||
| /** | ||
| * The latest time for the data stored in the database | ||
| */ | ||
| public String latest; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you re-run "mvn license:format" to update the headers to the latest version?