Skip to content

Commit

Permalink
CSW Harvester - extract identifier field name
Browse files Browse the repository at this point in the history
  • Loading branch information
josegar74 committed Oct 12, 2023
1 parent f35d1de commit 7ef728d
Show file tree
Hide file tree
Showing 6 changed files with 64 additions and 11 deletions.
14 changes: 13 additions & 1 deletion services/csw-harvester/src/main/java/geocat/csw/CSWMetadata.java
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,24 @@ public class CSWMetadata {
private boolean lookForNestedDiscoveryService;
private String filter;

private String identifierFieldName;

public CSWMetadata(String harvesterId,
long endpointId,
int numberOfExpectedRecords,
String getRecordsUrl,
List<List<String>> nestedGetCapUrls,
String filter,
boolean lookForNestedDiscoveryService) {
boolean lookForNestedDiscoveryService,
String identifierFieldName) {
this.harvesterId = harvesterId;
this.endpointId = endpointId;
this.numberOfExpectedRecords = numberOfExpectedRecords;
this.getRecordsUrl = getRecordsUrl;
this.nestedGetCapUrls = nestedGetCapUrls;
this.filter = filter;
this.lookForNestedDiscoveryService = lookForNestedDiscoveryService;
this.identifierFieldName = identifierFieldName;
}

public boolean isLookForNestedDiscoveryService() {
Expand Down Expand Up @@ -83,4 +87,12 @@ public long getEndpointId() {
public void setEndpointId(long endpointId) {
this.endpointId = endpointId;
}

public String getIdentifierFieldName() {
return identifierFieldName;
}

public void setIdentifierFieldName(String identifierFieldName) {
this.identifierFieldName = identifierFieldName;
}
}
16 changes: 13 additions & 3 deletions services/csw-harvester/src/main/java/geocat/csw/CSWService.java
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ public CSWMetadata getMetadata(CSWEndPointDetectedEvent endPointDetectedEvent) t
String getRecordsUrl = endpoint_extractGetRecordsURL(endPointDetectedEvent);
int expectedNumberOfRecords = endpoint_numberOfRecordsMatchingFilter(endPointDetectedEvent, getRecordsUrl);

String identifierFieldName= endpoint_identifierFieldName(endPointDetectedEvent);

List<List<String>> nestedGetCaps = new ArrayList<>();
if (endPointDetectedEvent.isLookForNestedDiscoveryService())
nestedGetCaps = endpoint_nestedDiscovery(endPointDetectedEvent, getRecordsUrl);
Expand All @@ -66,7 +68,8 @@ public CSWMetadata getMetadata(CSWEndPointDetectedEvent endPointDetectedEvent) t
getRecordsUrl,
nestedGetCaps,
filter,
endPointDetectedEvent.isLookForNestedDiscoveryService());
endPointDetectedEvent.isLookForNestedDiscoveryService(),
identifierFieldName);
return result;
}

Expand All @@ -93,8 +96,15 @@ private String endpoint_extractGetRecordsURL(CSWEndPointDetectedEvent endPointDe
return cswGetCapHandler.extractGetRecordsURL(getcapXmlString);
}

public String GetRecords(String url, String filter, int startRecord, int endRecord, Boolean doNotSort) throws Exception {
private String endpoint_identifierFieldName(CSWEndPointDetectedEvent endPointDetectedEvent) throws Exception {
logger.debug("requesting GetCapabilities from URL=" + endPointDetectedEvent.getUrl());

String getcapXmlString = cswEngine.GetCapabilities(endPointDetectedEvent.getUrl());
return cswGetCapHandler.extractIdentifierFieldName(getcapXmlString);
}

public String GetRecords(String url, String filter, int startRecord, int endRecord, Boolean doNotSort, String identifierFieldName) throws Exception {
boolean _doNotSort = doNotSort != null && doNotSort;
return cswEngine.GetRecords(url, ogcFilterService.getRecordsXML(filter, startRecord, endRecord, _doNotSort));
return cswEngine.GetRecords(url, ogcFilterService.getRecordsXML(filter, startRecord, endRecord, _doNotSort, identifierFieldName));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,20 @@ public String extractGetRecordsURL(String getCapResponseXML) throws Exception {

return u.toString();
}

public String extractIdentifierFieldName(String getCapResponseXML) throws Exception {
Document getCapDoc = XMLTools.parseXML(getCapResponseXML);

String identifierFieldName = "";

NodeList nodes = XMLTools.xpath_nodeset(getCapDoc, "/Capabilities/OperationsMetadata/Operation[@name='GetRecords']/Constraint[@name='SupportedISOQueryables']/Value");
for (int i = 0; i < nodes.getLength(); i++) {
if (nodes.item(i).getTextContent().toLowerCase().equals("identifier") ||
nodes.item(i).getTextContent().toLowerCase().contains(":identifier")) {
identifierFieldName = nodes.item(i).getNodeValue();
break;
}
}
return identifierFieldName;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Node;

Expand Down Expand Up @@ -43,7 +44,7 @@ public class OGCFilterService {

public static String ORDERBY = " <ogc:SortBy>\n" +
" <ogc:SortProperty>\n" +
" <ogc:PropertyName>Identifier</ogc:PropertyName>\n" +
" <ogc:PropertyName>PUT_ORDERBYFIELDNMAE_HERE</ogc:PropertyName>\n" +
" <ogc:SortOrder>DESC</ogc:SortOrder>\n" +
" </ogc:SortProperty>\n" +
" </ogc:SortBy>\n";
Expand Down Expand Up @@ -124,7 +125,7 @@ public String getGetdiscoveryXml(String filter) throws Exception {
return GETDISCOVERY_XML.replace("PUT_FILTER_HERE", fullFilter);
}

public String getRecordsXML(String filter, int startRecord, int endRecord, boolean doNotSort) {
public String getRecordsXML(String filter, int startRecord, int endRecord, boolean doNotSort, String identifierFieldName) {
String xml;
int nrecords = endRecord - startRecord + 1;
if ((filter != null) && (!filter.isEmpty())) {
Expand All @@ -136,10 +137,11 @@ public String getRecordsXML(String filter, int startRecord, int endRecord, boole
xml = GETRECORDS_NO_FILTER_XML.replace("PUT_START_POSITION_HERE", Integer.toString(startRecord))
.replace("PUT_MAX_RECORDS_HERE", Integer.toString(nrecords));
}
if (doNotSort)
if (doNotSort || !StringUtils.hasLength(identifierFieldName)) {
xml = xml.replace("PUT_ORDERBY_HERE", "");
else
xml = xml.replace("PUT_ORDERBY_HERE", ORDERBY);
} else {
xml = xml.replace("PUT_ORDERBY_HERE", ORDERBY.replace("PUT_ORDERBYFIELDNMAE_HERE", identifierFieldName));
}
return xml;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ public class EndpointJob {
@Enumerated(EnumType.STRING)
private EndpointJobState state;

@Column(name = "identifier_field_name")
private String identifierFieldName;

@PrePersist
private void onInsert() {
this.createTimeUTC = ZonedDateTime.now(ZoneId.of("UTC"));
Expand Down Expand Up @@ -122,4 +125,12 @@ public String getUrl() {
public void setUrl(String url) {
this.url = url;
}

public String getIdentifierFieldName() {
return identifierFieldName;
}

public void setIdentifierFieldName(String identifierFieldName) {
this.identifierFieldName = identifierFieldName;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,16 @@ public EventProcessor_GetRecordsCommand() {
public EventProcessor_GetRecordsCommand externalProcessing() throws Exception {

GetRecordsCommand e = getInitiatingEvent();
String xml = cswService.GetRecords(e.getGetRecordsURL(), e.getFilter(), e.getStartRecordNumber(), e.getEndRecordNumber(), e.getDoNotSort());

EndpointJob endpointJob = endpointJobService.getById(e.getEndPointId());

String xml = cswService.GetRecords(e.getGetRecordsURL(), e.getFilter(), e.getStartRecordNumber(), e.getEndRecordNumber(), e.getDoNotSort(), endpointJob.getIdentifierFieldName());
//logger.debug("starting to parse xml");
Document xmlParsed = MetadataExploderService.parseXML(xml);
//logger.debug("finish parse xml");

GetRecordsResponseInfo info = new GetRecordsResponseInfo(xmlParsed);
HarvestJob harvestJob = harvestJobService.getById(e.getHarvesterId()).get();
EndpointJob endpointJob = endpointJobService.getById(e.getEndPointId());
RecordSet recordSet = recordSetService.getById(e.getRecordSetId());

//logger.debug("eval...");
Expand Down

0 comments on commit 7ef728d

Please sign in to comment.