Use the word "record" instead of "entity" in data model docs.
This commit is contained in:
parent
934ea34a83
commit
6858ae694e
|
@ -12,9 +12,9 @@ streams from sensors or other applications.
|
|||
|
||||
## Data types
|
||||
|
||||
Data is organized into high-level data types called entities. The two primary
|
||||
record keeping entity types are **Assets** and **Logs**. Other entity types
|
||||
include **Quantities**, **Terms**, **Plans**, and **Users**.
|
||||
Data is organized into a set of high-level data types. The two primary record
|
||||
keeping data types are **Assets** and **Logs**. Other types include
|
||||
**Quantities**, **Terms**, **Plans**, and **Users**.
|
||||
|
||||
- [Assets](/model/type/asset)
|
||||
- [Logs](/model/type/log)
|
||||
|
|
|
@ -140,8 +140,8 @@ into the standard Asset attributes.
|
|||
|
||||
## Relationships
|
||||
|
||||
Assets can be related to other entities in farmOS These relationships are
|
||||
stored as entity reference fields on Asset entities.
|
||||
Assets can be related to other records in farmOS These relationships are
|
||||
stored as reference fields on Asset records.
|
||||
|
||||
All Assets have the same standard set of relationships. Modules can add
|
||||
additional relationships.
|
||||
|
|
|
@ -135,10 +135,10 @@ have quantitative data via related **Quantities**. They can be assigned to the
|
|||
**Users** who are responsible for them. And they can be organized using
|
||||
**Terms** and other metadata.
|
||||
|
||||
These relationships are stored as entity reference fields on Log entities.
|
||||
References are uni-directional, meaning that Logs reference Assets, but Assets
|
||||
do not reference Logs. It is possible to retrieve all Logs that reference a
|
||||
particular Asset, as well as retrieve all Assets referenced by a Log.
|
||||
These relationships are stored as reference fields on Logs. References are
|
||||
uni-directional, meaning that Logs reference Assets, but Assets do not
|
||||
reference Logs. It is possible to retrieve all Logs that reference a particular
|
||||
Asset, as well as retrieve all Assets referenced by a Log.
|
||||
|
||||
All Logs have the same standard set of relationships. Modules can add
|
||||
additional relationships.
|
||||
|
@ -174,7 +174,7 @@ For more information, see [farmOS Location Logic](/model/logic/location).
|
|||
|
||||
#### Quantities
|
||||
|
||||
Quantities are entities that contain quantitative data. These are used to
|
||||
Quantities are records that contain quantitative data. These are used to
|
||||
represent things like input amounts, harvest totals, time tracking, etc. For
|
||||
more information, see: [Quantities](/model/type/quantity).
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Plans
|
||||
|
||||
Plans are higher-level entities that organize Assets and Logs around a
|
||||
Plans are higher-level records that organize Assets and Logs around a
|
||||
particular goal. Modules can provide Plan types, along with additional UI and
|
||||
logic for Assets and Logs that are managed by them.
|
||||
|
||||
|
@ -73,7 +73,7 @@ into the standard Plan attributes.
|
|||
|
||||
## Relationships
|
||||
|
||||
Plans can reference other entity types (like Assets and Logs) that are "part of
|
||||
Plans can reference other record types (like Assets and Logs) that are "part of
|
||||
the Plan". These relationships can be simple (referencing the Asset/Log ID), or
|
||||
a Plan-type providing module can define more complex relationships by including
|
||||
other metadata alongside it.
|
||||
|
@ -118,14 +118,14 @@ Relationships that are common to all Plan types include:
|
|||
Images can be attached to Plans. This provides a place to store photos that can
|
||||
be displayed alongside the Plan in farmOS. If the photos pertain to specific
|
||||
Assets or Logs within the Plan, it may be better to attach them to those
|
||||
entities instead of the Plan.
|
||||
records instead of the Plan.
|
||||
|
||||
#### Files
|
||||
|
||||
Files can be attached to Plans. This provides a place to put documents such as
|
||||
Shapefiles, PDFs, CSVs, or other files associated with the Plan. If the files
|
||||
pertain to specific Assets or Logs within the Plan, it may be better to attach
|
||||
them to those entities instead of the Plan.
|
||||
them to those records instead of the Plan.
|
||||
|
||||
### Additional relationships
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Vocabularies (also referred to as taxonomies or ontologies) are used to
|
||||
organize and manage Terms used in various contexts throughout farmOS. These can
|
||||
be used for flagging, categorization, and organization of other entity types.
|
||||
be used for flagging, categorization, and organization of other record types.
|
||||
|
||||
Most Terms in farmOS are user-defined, and the vocabularies are empty when
|
||||
farmOS is first installed. As [Logs](/model/type/log) and
|
||||
|
|
Loading…
Reference in New Issue