/**
* ** Gets a virtual DBRecord from the specified remote service ** @param servReq The remote web
* service ** @return The virtual DBRecord (cannot be saved or reloaded)
*/
@SuppressWarnings("unchecked")
public gDBR getVirtualDBRecord(final ServiceRequest servReq) throws DBException {
String CMD_dbget = DBFactory.CMD_dbget;
String TAG_Response = servReq.getTagResponse();
String TAG_Record = DBFactory.TAG_Record;
String ATTR_command = servReq.getAttrCommand();
String ATTR_result = servReq.getAttrResult();
/* send request / get response */
Document xmlDoc = null;
try {
xmlDoc =
servReq.sendRequest(
CMD_dbget,
new ServiceRequest.RequestBody() {
public StringBuffer appendRequestBody(StringBuffer sb, int indent) {
return DBRecordKey.this.toRequestXML(sb, indent);
}
});
} catch (IOException ioe) {
Print.logException("Error", ioe);
throw new DBException("Request read error", ioe);
}
/* parse 'GTSResponse' */
Element gtsResponse = xmlDoc.getDocumentElement();
if (!gtsResponse.getTagName().equalsIgnoreCase(TAG_Response)) {
Print.logError("Request XML does not start with '%s'", TAG_Response);
throw new DBException("Response XML does not begin eith '" + TAG_Response + "'");
}
/* request command/argument */
String cmd = StringTools.trim(gtsResponse.getAttribute(ATTR_command));
String result = StringTools.trim(gtsResponse.getAttribute(ATTR_result));
if (StringTools.isBlank(result)) {
result = StringTools.trim(gtsResponse.getAttribute("type"));
}
if (!result.equalsIgnoreCase("success")) {
Print.logError("Response indicates failure");
throw new DBException("Response does not indicate 'success'");
}
/* Record */
NodeList rcdList = XMLTools.getChildElements(gtsResponse, TAG_Record);
if (rcdList.getLength() <= 0) {
Print.logError("No 'Record' tags");
throw new DBException("GTSResponse does not contain any 'Record' tags");
}
Element rcdElem = (Element) rcdList.item(0);
/* return DBRecord */
gDBR dbr = (gDBR) DBFactory.parseXML_DBRecord(rcdElem);
dbr.setVirtual(true);
return dbr;
}
// [System][Manufacturer][SubSystem][Problem] eg. "P0071" Powertrain
// References:
// http://www.obd-codes.com/trouble_codes/
// http://obdcon.sourceforge.net/2010/06/obd-ii-pids/
public static long EncodeFault_OBDII(String dtcStr) {
long faultCode = TYPE_OBDII;
/* trim */
dtcStr = StringTools.trim(dtcStr);
if (dtcStr.indexOf(",") >= 0) {
dtcStr = dtcStr.substring(0, dtcStr.indexOf(",")).trim();
}
if (dtcStr.equals("")) {
return faultCode;
}
/* check length */
if (dtcStr.length() == 4) {
dtcStr = "U" + dtcStr; // unknown
} else if (dtcStr.length() != 5) {
return faultCode;
}
/* active */
faultCode |= EncodeActive(true); // [ACTIVE_MASK] 0x0100000000000000
/* encode system cjaracter (ie. "Powertrain") */
faultCode |= EncodeSystem(dtcStr.charAt(0)); // [MID_MASK] 0x00FFFFFF00000000
/* encode manufacturer specific and subsystem */
int mfgCode = StringTools.parseInt(dtcStr.substring(1, 2), 0);
int spid = (mfgCode != 0) ? 0x8000 : 0;
int subSys = StringTools.parseInt(dtcStr.substring(2, 5), 0);
spid |= (subSys & 0xFFF);
faultCode |= EncodeSPID(spid); // [SPID_MASK] 0x00000000FFFF0000
/* return fault code */
return faultCode;
}
public String toString() {
StringBuffer sb = new StringBuffer();
/* standard event fields */
int sc = this.getStatusCode();
sb.append("Event values:\n");
sb.append(" DeviceID : " + this.getAccountID() + "/" + this.getDeviceID() + "\n");
sb.append(" UniqueID : " + this.getUniqueID() + "\n");
sb.append(
" Fixtime : " + this.getTimestamp() + " [" + new DateTime(this.getTimestamp()) + "]\n");
sb.append(
" StatusCode: [" + StatusCodes.GetHex(sc) + "] " + StatusCodes.GetDescription(sc, null));
sb.append(" GPS : " + this.getGeoPoint() + " [age " + this.getGpsAge() + " sec]\n");
sb.append(
" SpeedKPH : "
+ StringTools.format(this.getSpeedKPH(), "0.0")
+ " ["
+ this.getHeading()
+ "]\n");
/* remaining event fields (not already displayed) */
OrderedSet<?> fldn = new OrderedSet<Object>(this.fieldValues.getPropertyKeys());
fldn.remove(EventData.FLD_timestamp);
fldn.remove(EventData.FLD_statusCode);
fldn.remove(EventData.FLD_latitude);
fldn.remove(EventData.FLD_longitude);
fldn.remove(EventData.FLD_gpsAge);
fldn.remove(EventData.FLD_speedKPH);
fldn.remove(EventData.FLD_heading);
for (Object k : fldn) {
Object v = this.fieldValues.getProperty(k, "?");
sb.append(" ");
sb.append(StringTools.leftAlign(k.toString(), 10)).append(": ");
sb.append(v.toString()).append("\n");
}
/* alternate fields */
if (this.otherValues != null) {
for (String k : this.otherValues.keySet()) {
String v = StringTools.trim(this.otherValues.get(k));
sb.append(" ");
sb.append(StringTools.leftAlign(k, 10)).append(": ");
sb.append(v).append("\n");
}
}
/* return string */
return sb.toString();
}
/* write JS to stream */
public void writeJavaScript(PrintWriter out, RequestProperties reqState) throws IOException {
/* prefetch map "Loading" image */
if (this.getProperties().getBoolean(PROP_MAP_LOADING, false)) {
String mapLoadingImageURI = this.getProperties().getString(PROP_MAP_LOADING_IMAGE, null);
if (!StringTools.isBlank(mapLoadingImageURI)) {
out.write("<link rel=\"prefetch\" href=\"" + mapLoadingImageURI + "\">\n");
}
}
/* JSMap variables */
JavaScriptTools.writeStartJavaScript(out);
this.writeJSVariables(out, reqState);
JavaScriptTools.writeEndJavaScript(out);
/* Subclass JavaScript includes */
// links to MapProvider support are written by the subclass here
this.writeJSIncludes(out, reqState);
/* JSMap Custom included JavaScript */
String jsMapURLs[] =
StringTools.parseStringArray(this.getProperties().getString(PROP_javascript_src, ""), '\n');
this.writeJSIncludes(out, reqState, jsMapURLs);
/* JSMap Custom inline JavaScript */
String jsMapInline =
StringTools.trim(this.getProperties().getString(PROP_javascript_inline, null));
if (!StringTools.isBlank(jsMapInline)) {
JavaScriptTools.writeStartJavaScript(out);
out.write("// --- Inline Javascript [" + this.getName() + "]\n");
out.write(jsMapInline);
out.write("\n");
JavaScriptTools.writeEndJavaScript(out);
}
/* event CSV parsing code */
JavaScriptTools.writeStartJavaScript(out);
out.write(EventUtil.getInstance().getParseMapEventJS(reqState.isFleet(), reqState.getLocale()));
JavaScriptTools.writeEndJavaScript(out);
}
// http://code.google.com/apis/maps/documentation/geocoding/index.html
public GeoPoint getGeocode(String address, String country) {
/* URL */
String url = this.getGeoPointGeocodeURL(address, country);
Print.logDebug("Google GC URL: " + url);
/* create XML document */
Document xmlDoc = GetXMLDocument(url, this.getGeocodeTimeout());
if (xmlDoc == null) {
return null;
}
/* vars */
String errCode = null;
GeoPoint geoPoint = null;
/* parse "xml" */
Element kml = xmlDoc.getDocumentElement();
if (kml.getTagName().equalsIgnoreCase(TAG_kml)) {
NodeList ResponseList = XMLTools.getChildElements(kml, TAG_Response);
for (int g = 0; (g < ResponseList.getLength()); g++) {
Element response = (Element) ResponseList.item(g);
NodeList responseNodes = response.getChildNodes();
for (int n = 0; n < responseNodes.getLength(); n++) {
Node responseNode = responseNodes.item(n);
if (!(responseNode instanceof Element)) {
continue;
}
Element responseElem = (Element) responseNode;
String responseNodeName = responseElem.getNodeName();
if (responseNodeName.equalsIgnoreCase(TAG_name)) {
// <name>1600 Amphitheatre Parkway, Mountain View, CA</name>
} else if (responseNodeName.equalsIgnoreCase(TAG_Status)) {
// <Status> ... </Status>
NodeList statusNodes = responseElem.getChildNodes();
for (int st = 0; st < statusNodes.getLength(); st++) {
Node statusNode = statusNodes.item(st);
if (!(statusNode instanceof Element)) {
continue;
}
Element statusElem = (Element) statusNode;
String statusNodeName = statusElem.getNodeName();
if (statusNodeName.equalsIgnoreCase(TAG_code)) {
errCode = StringTools.trim(GoogleGeocodeV2.GetNodeText(statusElem)); // expect "200"
break; // we only care about the 'code'
}
}
} else if (responseNodeName.equalsIgnoreCase(TAG_Placemark)) {
// <Placemark> ... </Placemark>
String id = responseElem.getAttribute(ATTR_id);
if ((id != null) && id.equals("p1")) {
NodeList placemarkNodes = responseElem.getChildNodes();
for (int pm = 0; (geoPoint == null) && (pm < placemarkNodes.getLength()); pm++) {
Node placemarkNode = placemarkNodes.item(pm);
if (!(placemarkNode instanceof Element)) {
continue;
}
Element placemarkElem = (Element) placemarkNode;
String placemarkNodeName = placemarkElem.getNodeName();
if (placemarkNodeName.equalsIgnoreCase(TAG_Point)) {
NodeList pointNodes = placemarkElem.getChildNodes();
for (int ptn = 0; (geoPoint == null) && (ptn < pointNodes.getLength()); ptn++) {
Node pointNode = pointNodes.item(ptn);
if (!(pointNode instanceof Element)) {
continue;
}
Element pointElem = (Element) pointNode;
String pointNodeName = pointElem.getNodeName();
if (pointNodeName.equalsIgnoreCase(TAG_coordinates)) {
String ll[] = StringTools.split(GoogleGeocodeV2.GetNodeText(pointElem), ',');
if (ll.length >= 2) {
double lon = StringTools.parseDouble(ll[0], 0.0); // longitude is first
double lat = StringTools.parseDouble(ll[1], 0.0);
if (GeoPoint.isValid(lat, lon)) {
geoPoint = new GeoPoint(lat, lon);
break; // we only care about the 'GeoPoint'
}
}
}
}
}
}
} else {
// Print.logInfo("Skipping Placemark ID = %s", id);
}
}
}
}
}
/* create address */
if (geoPoint != null) {
// GeoPoint found
return geoPoint;
}
/* check for Google reverse-geocode limit exceeded */
if ((errCode != null) && errCode.equals("620")) {
Print.logError("!!!! Google Reverse-Geocode Limit Exceeded [Error 620] !!!!");
}
/* no reverse-geocode available */
return null;
}
/* return reverse-geocode using nearest address */
public ReverseGeocode getAddressReverseGeocode(GeoPoint gp, String localeStr, boolean cache) {
/* check for failover mode */
if (this.isReverseGeocodeFailoverMode()) {
ReverseGeocodeProvider frgp = this.getFailoverReverseGeocodeProvider();
return frgp.getReverseGeocode(gp, localeStr, cache);
}
/* URL */
String url = this.getAddressReverseGeocodeURL(gp, localeStr);
Print.logDebug("Google RG URL: " + url);
// byte xmlBytes[] = HTMLTools.readPage(url);
/* create XML document */
Document xmlDoc = GetXMLDocument(url, this.getReverseGeocodeTimeout());
if (xmlDoc == null) {
return null;
}
/* vars */
String errCode = null;
String address = null;
/* parse "xml" */
Element kml = xmlDoc.getDocumentElement();
if (kml.getTagName().equalsIgnoreCase(TAG_kml)) {
NodeList ResponseList = XMLTools.getChildElements(kml, TAG_Response);
for (int g = 0; (g < ResponseList.getLength()); g++) {
Element response = (Element) ResponseList.item(g);
NodeList responseNodes = response.getChildNodes();
for (int n = 0; n < responseNodes.getLength(); n++) {
Node responseNode = responseNodes.item(n);
if (!(responseNode instanceof Element)) {
continue;
}
Element responseElem = (Element) responseNode;
String responseNodeName = responseElem.getNodeName();
if (responseNodeName.equalsIgnoreCase(TAG_name)) {
// <name>40.479581,-117.773438</name>
} else if (responseNodeName.equalsIgnoreCase(TAG_Status)) {
// <Status> ... </Status>
NodeList statusNodes = responseElem.getChildNodes();
for (int st = 0; st < statusNodes.getLength(); st++) {
Node statusNode = statusNodes.item(st);
if (!(statusNode instanceof Element)) {
continue;
}
Element statusElem = (Element) statusNode;
String statusNodeName = statusElem.getNodeName();
if (statusNodeName.equalsIgnoreCase(TAG_code)) {
errCode = StringTools.trim(GoogleGeocodeV2.GetNodeText(statusElem)); // expect "200"
break; // we only care about the 'code'
}
}
} else if (responseNodeName.equalsIgnoreCase(TAG_Placemark)) {
// <Placemark> ... </Placemark>
String id = responseElem.getAttribute(ATTR_id);
if ((id != null) && id.equals("p1")) {
NodeList placemarkNodes = responseElem.getChildNodes();
for (int pm = 0; pm < placemarkNodes.getLength(); pm++) {
Node placemarkNode = placemarkNodes.item(pm);
if (!(placemarkNode instanceof Element)) {
continue;
}
Element placemarkElem = (Element) placemarkNode;
String placemarkNodeName = placemarkElem.getNodeName();
if (placemarkNodeName.equalsIgnoreCase(TAG_address)) {
address = GoogleGeocodeV2.GetNodeText(placemarkElem);
break; // we only care about the 'address'
}
}
} else {
// Print.logInfo("Skipping Placemark ID = %s", id);
}
}
}
}
}
/* create address */
if (FAILOVER_DEBUG) {
errCode = "620";
} else if (!StringTools.isBlank(address)) {
// address found
ReverseGeocode rg = new ReverseGeocode();
rg.setFullAddress(address);
return rg;
}
/* check for Google reverse-geocode limit exceeded */
if ((errCode != null) && errCode.equals("620")) {
Print.logError("!!!! Google Reverse-Geocode Limit Exceeded [Error 620] !!!!");
if (this.hasFailoverReverseGeocodeProvider()) {
this.startReverseGeocodeFailoverMode();
ReverseGeocodeProvider frgp = this.getFailoverReverseGeocodeProvider();
Print.logWarn("Failing over to '" + frgp.getName() + "'");
return frgp.getReverseGeocode(gp, localeStr, cache);
}
}
/* no reverse-geocode available */
return null;
}
public void setIconName(String v) {
this.setFieldValue(FLD_iconName, StringTools.trim(v));
}
public String getIconName() {
String v = (String) this.getFieldValue(FLD_iconName);
return StringTools.trim(v);
}
/* set the String ID for this record */
private void setStringID(String v) {
this.setFieldValue(FLD_stringID, StringTools.trim(v));
}
public String getGroupID() {
String v = (String) this.getFieldValue(FLD_groupID);
return StringTools.trim(v);
}
public String getStatusName() {
String v = (String) this.getFieldValue(FLD_statusName);
return StringTools.trim(v);
}
/* set the plural title */
public void setPluralTitle(String v) {
this.setFieldValue(FLD_pluralTitle, StringTools.trim(v));
}
/* return the plural title */
public String getPluralTitle() {
String v = (String) this.getFieldValue(FLD_pluralTitle);
return StringTools.trim(v);
}
/* set the singular title */
public void setSingularTitle(String v) {
this.setFieldValue(FLD_singularTitle, StringTools.trim(v));
}
/* return the singular title */
public String getSingularTitle() {
String v = (String) this.getFieldValue(FLD_singularTitle);
return StringTools.trim(v);
}
/**
* ** Returns a ReverseGeocode instance containing address information ** @param gp The GeoPoint
* ** @return The ReverseGeocode instance
*/
private ReverseGeocode getAddressReverseGeocode(GeoPoint gp, String localeStr) {
/* URL */
String url = this.getAddressReverseGeocodeURL(gp);
Print.logInfo("Address URL: " + url);
/* create XML document */
Document xmlDoc = GetXMLDocument(url);
if (xmlDoc == null) {
return null;
}
/* create ReverseGeocode response */
Element reversegeocode = xmlDoc.getDocumentElement();
if (!reversegeocode.getTagName().equalsIgnoreCase(TAG_reversegeocode)) {
return null;
}
/* init */
String address_val = null; // null address
String house_val = null; // house number
String road_val = null; // street name
String city_val = null; // city name
String county_val = null; // county name
String state_val = null; // state/province
String postcode_val = null; // postal code
String country_name_val = null; // country name
String country_code_val = null; // country code
// full address
NodeList resultList = XMLTools.getChildElements(reversegeocode, TAG_result);
for (int r = 0; r < resultList.getLength(); r++) {
Element result = (Element) resultList.item(r);
// String osmType = XMLTools.getAttribute(result, ATTR_osm_type, null, false);
address_val = XMLTools.getNodeText(result, " ", false);
break; // only the first element
}
// address components
NodeList addresspartsList = XMLTools.getChildElements(reversegeocode, TAG_addressparts);
for (int a = 0; (a < addresspartsList.getLength()); a++) {
Element addressparts = (Element) addresspartsList.item(a);
NodeList addresspartsChildren = addressparts.getChildNodes();
for (int ac = 0; ac < addresspartsChildren.getLength(); ac++) {
Node child = addresspartsChildren.item(ac);
if (!(child instanceof Element)) {
continue;
}
Element elem = (Element) child;
String elemName = elem.getNodeName();
if (elemName.equalsIgnoreCase(TAG_house)) {
house_val = XMLTools.getNodeText(elem, " ", false);
} else if (elemName.equalsIgnoreCase(TAG_tram)) {
// ignore
} else if (elemName.equalsIgnoreCase(TAG_road)) {
road_val = XMLTools.getNodeText(elem, " ", false);
} else if (elemName.equalsIgnoreCase(TAG_residential)) {
// ignore
} else if (elemName.equalsIgnoreCase(TAG_village)) {
// ignore
} else if (elemName.equalsIgnoreCase(TAG_town)) {
if (StringTools.isBlank(city_val)) {
city_val = XMLTools.getNodeText(elem, " ", false);
}
} else if (elemName.equalsIgnoreCase(TAG_city)) {
city_val = XMLTools.getNodeText(elem, " ", false);
} else if (elemName.equalsIgnoreCase(TAG_county)) {
county_val = XMLTools.getNodeText(elem, " ", false);
} else if (elemName.equalsIgnoreCase(TAG_postcode)) {
postcode_val = XMLTools.getNodeText(elem, " ", false);
} else if (elemName.equalsIgnoreCase(TAG_state)) {
state_val = XMLTools.getNodeText(elem, " ", false);
} else if (elemName.equalsIgnoreCase(TAG_country)) {
country_name_val = XMLTools.getNodeText(elem, " ", false);
} else if (elemName.equalsIgnoreCase(TAG_country_code)) {
country_code_val = StringTools.trim(XMLTools.getNodeText(elem, " ", false)).toUpperCase();
} else {
// elemName unrecognized
}
}
break; // only the first element
}
/* populate ReverseGeocode instance */
ReverseGeocode rg = new ReverseGeocode();
StringBuffer addr = new StringBuffer();
// house number /road
if (!StringTools.isBlank(house_val)) {
addr.append(house_val);
if (!StringTools.isBlank(road_val)) {
addr.append(" ");
addr.append(road_val);
rg.setStreetAddress(house_val + " " + road_val);
} else {
rg.setStreetAddress(house_val);
}
} else if (!StringTools.isBlank(road_val)) {
addr.append(road_val);
rg.setStreetAddress(road_val);
}
// city/county
if (!StringTools.isBlank(city_val)) {
if (addr.length() > 0) {
addr.append(", ");
}
addr.append(city_val);
rg.setCity(city_val);
}
if (!StringTools.isBlank(county_val)) {
if (StringTools.isBlank(city_val)) {
// "city" not provided, at least include the "county"
if (addr.length() > 0) {
addr.append(", ");
}
addr.append("[").append(county_val).append("]");
}
// rg.setCounty(county_val);
}
// state/province
if (!StringTools.isBlank(state_val)) {
if (addr.length() > 0) {
addr.append(", ");
}
addr.append(state_val);
rg.setStateProvince(state_val);
if (!StringTools.isBlank(postcode_val)) {
addr.append(" ").append(postcode_val);
rg.setPostalCode(postcode_val);
}
} else {
if (!StringTools.isBlank(postcode_val)) {
if (addr.length() > 0) {
addr.append(", ");
}
addr.append(postcode_val);
rg.setPostalCode(postcode_val);
}
}
// country
if (!StringTools.isBlank(country_code_val)) {
if (country_code_val.equalsIgnoreCase("US")) {
// if (addr.length() > 0) { addr.append(", "); }
// addr.append("USA");
} else if (!StringTools.isBlank(country_name_val)) {
if (addr.length() > 0) {
addr.append(", ");
}
addr.append(country_name_val);
} else {
if (addr.length() > 0) {
addr.append(", ");
}
addr.append(country_code_val);
}
rg.setCountryCode(country_code_val);
}
// full address
rg.setFullAddress(addr.toString());
return rg;
}
public void setStatusName(String v) {
this.setFieldValue(FLD_statusName, StringTools.trim(v));
}
public String getIconSelector() {
String v = (String) this.getFieldValue(FLD_iconSelector);
return StringTools.trim(v);
}
public void setIconSelector(String v) {
this.setFieldValue(FLD_iconSelector, StringTools.trim(v));
}
private void setGroupID(String v) {
this.setFieldValue(FLD_groupID, StringTools.trim(v));
}
public String getAclID() {
String v = (String) this.getFieldValue(FLD_aclID);
return StringTools.trim(v);
}