forked from wbinarytree/android-architecture-components
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add android-architecture-components to Google Samples index (#225)
- Add packaging.yaml files with project metadata - Ensure README.md files use correct format
- Loading branch information
1 parent
bf2a123
commit 6e0cd31
Showing
13 changed files
with
448 additions
and
59 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# | ||
# Copyright (C) 2017 The Android Open Source Project | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# GOOGLE SAMPLE PACKAGING DATA | ||
# | ||
# This file is used by Google as part of our samples packaging process. | ||
# End users may safely ignore this file. It has no relevance to other systems. | ||
--- | ||
# Values: {DRAFT | PUBLISHED | INTERNAL | DEPRECATED | SUPERCEDED} | ||
status: PUBLISHED | ||
|
||
# Optional, put additional explanation here for DEPRECATED or SUPERCEDED. | ||
# statusNote: | ||
|
||
# See http://go/sample-categories | ||
technologies: [Android] | ||
categories: [Architecture] | ||
languages: [Java] | ||
solutions: [Mobile] | ||
|
||
# May be omitted if unpublished | ||
github: googlesamples/android-architecture-components | ||
|
||
# Values: BEGINNER | INTERMEDIATE | ADVANCED | EXPERT | ||
level: ADVANCED | ||
|
||
# Default: apache2. May be omitted for most samples. | ||
# Alternatives: apache2-android (for AOSP) | ||
license: apache2 |
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 |
---|---|---|
@@ -1,23 +1,53 @@ | ||
# Room & RxJava Sample | ||
Room & RxJava Sample | ||
===================== | ||
|
||
This is an API sample to showcase how to implement observable queries in [Room](https://developer.android.com/topic/libraries/architecture/room.html), with RxJava's [Flowable](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Flowable.html) objects. | ||
This is an API sample to showcase how to implement observable queries in | ||
[Room](https://developer.android.com/topic/libraries/architecture/room.html), with RxJava's | ||
[Flowable](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Flowable.html) objects. | ||
|
||
# Functionality | ||
Introduction | ||
------------- | ||
|
||
### Functionality | ||
The sample app shows an editable user name, stored in the database. | ||
|
||
# Implementation | ||
### Implementation | ||
|
||
#### Data layer | ||
|
||
## Data layer | ||
The database is created using Room and has one entity: a `User`. Room generates the corresponding SQLite table at | ||
runtime. | ||
|
||
The database is created using Room and has one entity: a `User`. Room generates the corresponding SQLite table at runtime. | ||
Queries are executed in the `UserDao` class. The user retrieval is done via an observable query implemented using a `Flowable`. Every time the user data is updated, the Flowable object will emit automatically, allowing to update the UI based on the latest data. The Flowable will emit only when the query result contains at least a row. When there is no data to match the query, the Flowable will not emit. | ||
Queries are executed in the `UserDao` class. The user retrieval is done via an observable query implemented using a | ||
`Flowable`. Every time the user data is updated, the Flowable object will emit automatically, allowing to update the UI | ||
based on the latest data. The Flowable will emit only when the query result contains at least a row. When there is no | ||
data to match the query, the Flowable will not emit. | ||
|
||
## Presentation layer | ||
#### Presentation layer | ||
|
||
The app has a main Activity that displays the data. | ||
The Activity works with a ViewModel to do the following: | ||
* subscribe to the emissions of the user name and update the UI every time there is a new user name emitted | ||
* notify the ViewModel when the "Update" button is pressed and pass the new user name. | ||
The ViewModel works with the data source to get and save the data. | ||
|
||
Room guarantees that the observable query will be triggered on a background thread. In the Activity, the Flowable events are set to be received on the main thread, so the UI can be updated. The insert query is synchronous so it's wrapped in a Completable and executed on a background thread. On completion, the Activity is notified on the main thread. | ||
Room guarantees that the observable query will be triggered on a background thread. In the Activity, the Flowable events | ||
are set to be received on the main thread, so the UI can be updated. The insert query is synchronous so it's wrapped in | ||
a Completable and executed on a background thread. On completion, the Activity is notified on the main thread. | ||
|
||
License | ||
-------- | ||
|
||
Copyright (C) 2017 The Android Open Source Project | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
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,41 @@ | ||
# | ||
# Copyright (C) 2017 The Android Open Source Project | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# GOOGLE SAMPLE PACKAGING DATA | ||
# | ||
# This file is used by Google as part of our samples packaging process. | ||
# End users may safely ignore this file. It has no relevance to other systems. | ||
--- | ||
# Values: {DRAFT | PUBLISHED | INTERNAL | DEPRECATED | SUPERCEDED} | ||
status: PUBLISHED | ||
|
||
# Optional, put additional explanation here for DEPRECATED or SUPERCEDED. | ||
# statusNote: | ||
|
||
# See http://go/sample-categories | ||
technologies: [Android] | ||
categories: [Architecture] | ||
languages: [Kotlin] | ||
solutions: [Mobile] | ||
|
||
# May be omitted if unpublished | ||
github: googlesamples/android-architecture-components | ||
|
||
# Values: BEGINNER | INTERMEDIATE | ADVANCED | EXPERT | ||
level: ADVANCED | ||
|
||
# Default: apache2. May be omitted for most samples. | ||
# Alternatives: apache2-android (for AOSP) | ||
license: apache2 |
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 |
---|---|---|
@@ -1,23 +1,52 @@ | ||
# Room & RxJava Kotlin Sample | ||
Room & RxJava (Kotlin) Sample | ||
============================ | ||
|
||
This is an API sample to showcase how to use [Room](https://developer.android.com/topic/libraries/architecture/room.html), with RxJava's [Flowable](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Flowable.html) objects in Kotlin. | ||
This is an API sample to showcase how to use [Room](https://developer.android.com/topic/libraries/architecture/room.html), | ||
with RxJava's [Flowable](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Flowable.html) objects in Kotlin. | ||
|
||
# Functionality | ||
Introduction | ||
------------- | ||
|
||
### Functionality | ||
The sample app shows an editable user name, stored in the database. | ||
|
||
# Implementation | ||
### Implementation | ||
|
||
#### Data layer | ||
|
||
## Data layer | ||
The database is created using Room and has one entity: a `User`. Room generates the corresponding SQLite table at | ||
runtime. | ||
|
||
The database is created using Room and has one entity: a `User`. Room generates the corresponding SQLite table at runtime. | ||
Queries are executed in the `UserDao` class. The user retrieval is done via an observable query implemented using a `Flowable`. Every time the user data is updated, the Flowable object will emit automatically, allowing to update the UI based on the latest data. The Flowable will emit only when the query result contains at least a row. When there is no data to match the query, the Flowable will not emit. | ||
Queries are executed in the `UserDao` class. The user retrieval is done via an observable query implemented using a | ||
`Flowable`. Every time the user data is updated, the Flowable object will emit automatically, allowing to update the UI | ||
based on the latest data. The Flowable will emit only when the query result contains at least a row. When there is no | ||
data to match the query, the Flowable will not emit. | ||
|
||
## Presentation layer | ||
#### Presentation layer | ||
|
||
The app has a main Activity that displays the data. | ||
The Activity works with a ViewModel to do the following: | ||
* subscribe to the emissions of the user name and updates the UI every time there is a new user name emitted | ||
* notify the ViewModel when the pressed the "Update" and passes the new user name. | ||
The ViewModel works with the data source to get and save the data. | ||
|
||
Room guarantees that the observable query will be triggered on a background thread. In the Activity, the Flowable events are set to be received on the main thread, so the UI can be updated. The insert query is synchronous so it's wrapped in a Completable and executed on a background thread. On completion, the Activity is notified on the main thread. | ||
Room guarantees that the observable query will be triggered on a background thread. In the Activity, the Flowable events | ||
are set to be received on the main thread, so the UI can be updated. The insert query is synchronous so it's wrapped in | ||
a Completable and executed on a background thread. On completion, the Activity is notified on the main thread. | ||
|
||
License | ||
-------- | ||
|
||
Copyright (C) 2017 The Android Open Source Project | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
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,41 @@ | ||
# | ||
# Copyright (C) 2017 The Android Open Source Project | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# GOOGLE SAMPLE PACKAGING DATA | ||
# | ||
# This file is used by Google as part of our samples packaging process. | ||
# End users may safely ignore this file. It has no relevance to other systems. | ||
--- | ||
# Values: {DRAFT | PUBLISHED | INTERNAL | DEPRECATED | SUPERCEDED} | ||
status: PUBLISHED | ||
|
||
# Optional, put additional explanation here for DEPRECATED or SUPERCEDED. | ||
# statusNote: | ||
|
||
# See http://go/sample-categories | ||
technologies: [Android] | ||
categories: [Architecture] | ||
languages: [Java] | ||
solutions: [Mobile] | ||
|
||
# May be omitted if unpublished | ||
github: googlesamples/android-architecture-components | ||
|
||
# Values: BEGINNER | INTERMEDIATE | ADVANCED | EXPERT | ||
level: ADVANCED | ||
|
||
# Default: apache2. May be omitted for most samples. | ||
# Alternatives: apache2-android (for AOSP) | ||
license: apache2 |
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,41 @@ | ||
# | ||
# Copyright (C) 2017 The Android Open Source Project | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# GOOGLE SAMPLE PACKAGING DATA | ||
# | ||
# This file is used by Google as part of our samples packaging process. | ||
# End users may safely ignore this file. It has no relevance to other systems. | ||
--- | ||
# Values: {DRAFT | PUBLISHED | INTERNAL | DEPRECATED | SUPERCEDED} | ||
status: PUBLISHED | ||
|
||
# Optional, put additional explanation here for DEPRECATED or SUPERCEDED. | ||
# statusNote: | ||
|
||
# See http://go/sample-categories | ||
technologies: [Android] | ||
categories: [Architecture] | ||
languages: [Java] | ||
solutions: [Mobile] | ||
|
||
# May be omitted if unpublished | ||
github: googlesamples/android-architecture-components | ||
|
||
# Values: BEGINNER | INTERMEDIATE | ADVANCED | EXPERT | ||
level: ADVANCED | ||
|
||
# Default: apache2. May be omitted for most samples. | ||
# Alternatives: apache2-android (for AOSP) | ||
license: apache2 |
Oops, something went wrong.