diff --git a/ip-intelligence.shared/src/main/java/fiftyone/ipintelligence/shared/IPIntelligenceData.java b/ip-intelligence.shared/src/main/java/fiftyone/ipintelligence/shared/IPIntelligenceData.java index 35e0105..f1d2fa9 100644 --- a/ip-intelligence.shared/src/main/java/fiftyone/ipintelligence/shared/IPIntelligenceData.java +++ b/ip-intelligence.shared/src/main/java/fiftyone/ipintelligence/shared/IPIntelligenceData.java @@ -189,7 +189,15 @@ public interface IPIntelligenceData extends AspectData */ AspectPropertyValue getLatitude(); /** - * The confidence in the town and country provided. + * The confidence in the town and country provided. Returns one of High, Medium, Low, or Unknown. The confidence must be checked before using the returned location values. + *

+ * Possible values: + *

+	 * High      High confidence results can be relied upon and considered useful for all practical purposes.
+	 * Medium    Medium confidence results might be useful where the use case can tolerate a degree of inaccuracy.
+	 * Low       Low confidence results should be discarded when the results might be used to make consequential decisions.
+	 * Unknown   Unknown confidence results should be treated in the same way as Low and discarded when the results might be used to m...
+	 * 
*/ AspectPropertyValue getLocationConfidence(); /** @@ -233,7 +241,7 @@ public interface IPIntelligenceData extends AspectData */ AspectPropertyValue getTimeZoneIana(); /** - * The offset from UTC in minutes in the supplied location, at the time that the value is produced. A value of -1 indicates unknown. + * The offset from UTC in minutes in the supplied location, at the time that the value is produced. A value of -1 means the offset is unknown and is only returned when no location can be determined for the IP address. Real offsets are whole multiples of 15 minutes, so -1 never collides with a genuine value. */ AspectPropertyValue getTimeZoneOffset(); /** diff --git a/ip-intelligence.shared/src/main/java/fiftyone/ipintelligence/shared/IPIntelligenceDataBase.java b/ip-intelligence.shared/src/main/java/fiftyone/ipintelligence/shared/IPIntelligenceDataBase.java index db2b443..36f721c 100644 --- a/ip-intelligence.shared/src/main/java/fiftyone/ipintelligence/shared/IPIntelligenceDataBase.java +++ b/ip-intelligence.shared/src/main/java/fiftyone/ipintelligence/shared/IPIntelligenceDataBase.java @@ -279,7 +279,15 @@ protected IPIntelligenceDataBase( @Override public AspectPropertyValue getLatitude() { return getAs("latitude", AspectPropertyValue.class, Float.class); } /** - * The confidence in the town and country provided. + * The confidence in the town and country provided. Returns one of High, Medium, Low, or Unknown. The confidence must be checked before using the returned location values. + *

+ * Possible values: + *

+	 * High      High confidence results can be relied upon and considered useful for all practical purposes.
+	 * Medium    Medium confidence results might be useful where the use case can tolerate a degree of inaccuracy.
+	 * Low       Low confidence results should be discarded when the results might be used to make consequential decisions.
+	 * Unknown   Unknown confidence results should be treated in the same way as Low and discarded when the results might be used to m...
+	 * 
*/ @SuppressWarnings("unchecked") @Override @@ -345,7 +353,7 @@ protected IPIntelligenceDataBase( @Override public AspectPropertyValue getTimeZoneIana() { return getAs("timezoneiana", AspectPropertyValue.class, String.class); } /** - * The offset from UTC in minutes in the supplied location, at the time that the value is produced. A value of -1 indicates unknown. + * The offset from UTC in minutes in the supplied location, at the time that the value is produced. A value of -1 means the offset is unknown and is only returned when no location can be determined for the IP address. Real offsets are whole multiples of 15 minutes, so -1 never collides with a genuine value. */ @SuppressWarnings("unchecked") @Override