/**
* ** 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;
}
/**
* ** Returns true if the parent records in their respective parent tables exist. ** @return True
* if the parent records exist.
*/
public boolean parentsExist() throws DBException {
DBFactory<gDBR> dbFact = this.getFactory();
DBFieldValues myFldVals = this.getFieldValues();
java.util.List<String> parentList = dbFact.getParentTables();
for (String parentTable : parentList) {
/* get parent table DBFactory */
Print.logInfo("[%s] Parent table: %s", this.getTableName(), parentTable);
DBFactory parentFact = DBFactory.getFactoryByName(parentTable);
if (parentFact == null) {
Print.logError("Unexpected error finding parent table: " + parentTable);
return false;
}
/* create parent record key with fields from this key */
DBRecordKey parentKey = parentFact.createKey(); // an empty key
DBField parentKeyFlds[] = parentFact.getKeyFields();
for (DBField pkf : parentKeyFlds) {
String pfn = pkf.getName();
/* get this DBField */
DBField myKeyFld = this.getField(pfn);
if (myKeyFld == null) {
Print.logError("Unexpected error finding field: [" + this.getTableName() + "] " + pfn);
return false;
}
/* get parent key field value */
Object pkv = myFldVals.getFieldValue(pfn);
if (pkv == null) {
Print.logError("Unexpected error finding parent field: [" + parentTable + "] " + pfn);
return false;
}
if (myKeyFld.isDefaultValue(pkv)) {
Print.logInfo("This key contains a global value, skipping parent check: " + parentTable);
parentKey = null;
break;
}
parentKey.setFieldValue(pfn, pkv);
}
/* check parent existence */
if ((parentKey != null) && !parentKey.exists()) {
Print.logError("Parent record does not exist: [" + parentTable + "] " + parentKey);
return false;
}
}
return true;
}
private Document GetXMLDocument(String url) {
try {
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
DocumentBuilder db = dbf.newDocumentBuilder();
InputStream input = HTMLTools.inputStream_GET(url, 5000);
InputStreamReader reader = new InputStreamReader(input, ENCODING_UTF8);
InputSource inSrc = new InputSource(reader);
inSrc.setEncoding(ENCODING_UTF8);
return db.parse(inSrc);
} catch (ParserConfigurationException pce) {
Print.logError("Parse error: " + pce);
return null;
} catch (SAXException se) {
Print.logError("Parse error: " + se);
return null;
} catch (IOException ioe) {
Print.logError("IO error: " + ioe);
return null;
}
}
/**
* ** Returns true if the specified key attribute exists in the table ** @param altIndexName The
* alternate index name, or null to use the primary index ** @param whereKeyType The partial key
* match type ** @return True if the specified key attribute exists in the table, false otherwise
*/
protected boolean _exists(String altIndexName, int whereKeyType)
throws SQLException, DBException {
/* key fields */
boolean usePrimaryKey = StringTools.isBlank(altIndexName);
DBField kfld[] = usePrimaryKey ? this.getKeyFields() : this.getAltKeyFields(altIndexName);
if (ListTools.isEmpty(kfld)) {
throw new DBException("No keys found!");
}
/* check last key for "auto_increment" */
if (whereKeyType == DBWhere.KEY_FULL) {
DBField lastField = kfld[kfld.length - 1];
if (lastField.isAutoIncrement()
&& !this.getFieldValues().hasFieldValue(lastField.getName())) {
// full key requested and last key is auto_increment, which is missing
return false;
}
}
// DBSelect: SELECT <Keys> FROM <TableName> <KeyWhere>
String firstKey = kfld[0].getName();
DBSelect<gDBR> dsel = new DBSelect<gDBR>(this.getFactory());
dsel.setSelectedFields(firstKey);
dsel.setWhere(this._getWhereClause(altIndexName, whereKeyType));
/* get keyed record */
DBConnection dbc = null;
Statement stmt = null;
ResultSet rs = null;
boolean exists = false;
try {
dbc = DBConnection.getDefaultConnection();
stmt = dbc.execute(dsel.toString()); // may throw DBException
rs = stmt.getResultSet();
exists = rs.next();
} catch (SQLException sqe) {
if (sqe.getErrorCode() == DBFactory.SQLERR_TABLE_NOTLOCKED) {
// MySQL: This case has been seen on rare occasions. Not sure what causes it.
Print.logError("SQL Lock Error: " + sqe);
Print.logError("Hackery! Forcing lock on table: " + this.getTableName());
if (DBProvider.lockTableForRead(this.getTableName(), true)) { // may throw DBException
stmt = dbc.execute(dsel.toString()); // may throw SQLException, DBException
rs = stmt.getResultSet(); // SQLException
exists = rs.next(); // SQLException
DBProvider.unlockTables(); // DBException
}
} else {
throw sqe;
}
} finally {
if (rs != null) {
try {
rs.close();
} catch (Throwable t) {
}
}
if (stmt != null) {
try {
stmt.close();
} catch (Throwable t) {
}
}
DBConnection.release(dbc);
}
return exists;
}
// 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;
}