OvulationTestRecord
public final class OvulationTestRecord implements Record
Each record represents the result of an ovulation test.
Summary
Constants |
|
|---|---|
static final int |
RESULT_HIGH = 2High fertility. |
static final int |
Inconclusive result. |
static final int |
RESULT_NEGATIVE = 3Negative fertility (may also be referred as "low" fertility). |
static final int |
RESULT_POSITIVE = 1Positive fertility (may also be referred as "peak" fertility). |
Public constructors |
|---|
OvulationTestRecord( |
Public methods |
|
|---|---|
boolean |
|
@NonNull Metadata |
Set of common metadata associated with the written record. |
final int |
The result of a user's ovulation test, which shows if they're ovulating or not. |
@NonNull Instant |
getTime()Time the record happened. |
ZoneOffset |
User experienced zone offset at |
int |
hashCode() |
@NonNull String |
toString() |
Constants
RESULT_HIGH
public static final int RESULT_HIGH = 2
High fertility. Refers to a rise in estrogen or luteinizing hormone that may signal the fertile window (time in the menstrual cycle when conception is likely to occur).
RESULT_INCONCLUSIVE
public static final int RESULT_INCONCLUSIVE = 0
Inconclusive result. Refers to ovulation test results that are indeterminate (e.g. may be testing malfunction, user error, etc.). ". Any unknown value will also be returned as RESULT_INCONCLUSIVE.
RESULT_NEGATIVE
public static final int RESULT_NEGATIVE = 3
Negative fertility (may also be referred as "low" fertility). Refers to the time in the cycle where fertility/conception is expected to be low.
RESULT_POSITIVE
public static final int RESULT_POSITIVE = 1
Positive fertility (may also be referred as "peak" fertility). Refers to the peak of the luteinizing hormone (LH) surge and ovulation is expected to occur in 10-36 hours.
Public constructors
OvulationTestRecord
public OvulationTestRecord(
@NonNull Instant time,
ZoneOffset zoneOffset,
int result,
@NonNull Metadata metadata
)
Public methods
getMetadata
public @NonNull Metadata getMetadata()
Set of common metadata associated with the written record.
getResult
public final int getResult()
The result of a user's ovulation test, which shows if they're ovulating or not. Required field.
getZoneOffset
public ZoneOffset getZoneOffset()
User experienced zone offset at time, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.