Equivalent XPath and APS Queries

From edegan.com
Revision as of 15:16, 21 June 2017 by OliverC (talk | contribs)
Jump to navigation Jump to search


McNair Project
Equivalent XPath and APS Queries
Project logo 02.png
Project Information
Project Title Equivalent XPath and APS Queries
Owner Oliver Chang, Ed Egan
Start Date June 2017
Deadline June 2017
Primary Billing
Notes
Has project status Active
Copyright © 2016 edegan.com. All Rights Reserved.



Current Status for Granted Patents implementation


How it works currently

Only has the intelligence from E:\McNair\PatentData\Processed\xmlparser_4.5_4.4_4.3.pl. That is to say, it only explicitly covers versions 4.3, 4.4, and 4.5 utility patents. Plant, reissue, and design patents contain a nonempty intersection with these attributes but have their own quirks. The actual code to do this XML parsing is at E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\uspto_granted\XmlParser.java with the end goal to create an in-memory representation of a granted patent as a E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\models\GrantedPatent.java data structure.

To learn about the fields that a model contains, look at the class Model.Metadata which should implement interface TableMetadata. In particular, this bunch of constant data describes the mapping of enum fields to table column names as well as the types of columns.

For an example, we can tell that GrantedPatent is a struct that contains the following data:

private final Map<GrantedPatent.Fields, String> strings;
private final Map<GrantedPatent.Fields, Double> numbers;
private final List<Citation> citations;
private final List<Sciref> scirefs;
private final List<Inventor> inventors;
private final List<AssignmentSummary> assignments;
private final List<Lawyer> lawyers;

Query Equivalences

strings

  • PATENT_TYPE
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/application-reference/@appl-type
    • APS
      • PATN:APT
  • TITLE
    • XML 4.3, 4.4, 4.5
      • //invention-title
    • APS
      • PATN:TTL
  • PCT_DOCUMENT_NUMBER
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/pct-or-regional-filing-data/document-id/doc-number
    • APS
      • PCTA:PCN
  • PATENT_COUNTRY
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/publication-reference/document-id/country
    • APS
      •  ?
  • PATENT_NUMBER
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/publication-reference/document-id/doc-number
    • APS
      • PATN:WKU
  • PATENT_KIND
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/publication-reference/document-id/doc-number/kind
    • APS
      •  ?
  • PATENT_GRANT_DATE
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/publication-reference/document-id/date
    • APS
      • PATN:ISD
  • APPLICATION_NUMBER
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/application-reference/document-id/doc-number
    • APS
      • PATN:APN
  • APPLICATION_FILING_DATE
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/application-reference/document-id/date
    • APS
      • PATN:APD
  • PRIORITY_CLAIMS_DATE
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/priority-claims/priority-claim/date
    • APS
      • PRIR:APD
  • PRIORITY_CLAIMS_COUNTRY
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/priority-claims/priority-claim/country
    • APS
      • PRIR:CNT
  • PRIORITY_CLAIMS_PATENT_NUMBER
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/priority-claims/priority-claim/doc-number
    • APS
      • PRIR:APN
  • IPCR_SUBCLASS
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/section + //us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/class + //us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/subclass
    • APS
      •  ?
  • IPCR_MAIN_GROUP
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/main-group
    • APS
      •  ?
  • IPCR_SUB_GROUP
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/subgroup
    • APS
      •  ?
  • CPC_SUBCLASS
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/section + //us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/class + //us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/subclass
    • APS
      •  ?
  • CPC_MAIN_GROUP
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/main-group
    • APS
      •  ?
  • CPC_SUB_GROUP
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/subgroup
    • APS
      •  ?
  • CLASSIFICATION_NATIONAL_COUNTRY
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //us-bibliographic-data-grant/classification-national/country
      • //us-bibliographic-data-grant/us-field-of-classification-search/classification-national/country
    • APS
      •  ?
  • CLASSIFICATION_NATIONAL_CLASS
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //us-bibliographic-data-grant/classification-national/main-classification
      • //us-bibliographic-data-grant/us-field-of-classification-search/classification-national/country
    • APS
      •  ?
  • PRIMARY_EXAMINER_FIRST_NAME
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/examiners/primary-examiner/first-name
    • APS
      • PATN:EXP (whole name)
  • PRIMARY_EXAMINER_LAST_NAME
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/examiners/primary-examiner/last-name
    • APS
      • N/A (PATN:EXP has whole name)
  • PRIMARY_EXAMINER_DEPARTMENT
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/examiners/primary-examiner/department
    • APS
      •  ?

numbers

  • NUMBER_OF_CLAIMS
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/number-of-claims
    • APS
      • PATN:NCL

citations (all are strings)

  • SEQUENCE
    • XML 4.3, 4.4, 4.5
      • //us-parties/inventors/inventor/sequence
    • XML 4.0, 4.1, 4.2
      • //parties/applicants/applicant/sequence
    • APS
      •  ?
  • LAST_NAME
    • XML 4.3, 4.4, 4.5
      • //us-parties/inventors/inventor/addressbook/last-name
    • XML 4.0, 4.1, 4.2
      • //parties/applicants/applicant/addressbook/last-name
    • APS
      • N/A (see ORG_NAME)
  • FIRST_NAME
    • XML 4.3, 4.4, 4.5
      • //us-parties/inventors/inventor/addressbook/first-name
    • XML 4.0, 4.1, 4.2
      • //parties/applicants/applicant/addressbook/first-name
    • APS
      • N/A (see ORG_NAME)
  • ORG_NAME
    • XML 4.3, 4.4, 4.5
      • //us-parties/inventors/inventor/addressbook/orgname
    • XML 4.0, 4.1, 4.2
      • //parties/applicants/applicant/addressbook/orgname
    • APS
      • INVT:NAM (whole name, might be of an individual)
  • CITY
    • XML 4.3, 4.4, 4.5
      •  ?
    • XML 4.0, 4.1, 4.2
      •  ?
    • APS
      • INVT:CTY
  • COUNTRY
    • XML 4.3, 4.4, 4.5
      •  ?
    • XML 4.0, 4.1, 4.2
      •  ?
    • APS
      • INVT:CNT
  • STATE
    • XML 4.3, 4.4, 4.5
      •  ?
    • XML 4.0, 4.1, 4.2
      •  ?
    • APS
      • INVT:STA
  • ADDRESS
    • XML 4.3, 4.4, 4.5
      •  ?
    • XML 4.0, 4.1, 4.2
      •  ?
    • APS
      • INVT:STR
  • POSTCODE
    • XML 4.3, 4.4, 4.5
      •  ?
    • XML 4.0, 4.1, 4.2
      •  ?
    • APS
      • INVT:ZIP

scirefs (all are strings)

  • CITATION_DESCRIPTION
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/us-references-cited/us-citation/nplcit/othercit
    • XML 4.0, 4.1, 4.2
      • //us-bibliographic-data-grant/references-cited/citation/nplcit/othercit
    • APS
      •  ?

inventors (all are strings)

  • SEQUENCE
    • XML 4.3, 4.4, 4.5
      • //us-parties/inventors/inventor/sequence
    • XML 4.0, 4.1, 4.2
      • //parties/applicants/applicant/sequence
  • LAST_NAME
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //us-parties/inventors/inventor/addressbook/last-name
      • //us-parties/inventors/inventor/last-name
    • XML 4.0, 4.1, 4.2 (first listed is highest preference)
      • //parties/applicants/applicant/addressbook/last-name
      • //parties/applicants/applicant/last-name
    • APS
      • N/A (see ORG_NAME)
  • FIRST_NAME
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //us-parties/inventors/inventor/addressbook/first-name
      • //us-parties/inventors/inventor/first-name/
    • XML 4.0, 4.1, 4.2 (first listed is highest preference)
      • //parties/applicants/applicant/addressbook/first-name
      • //parties/applicants/applicant/first-name
    • APS
      • N/A (see ORG_NAME
  • ORG_NAME
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //us-parties/inventors/inventor/addressbook/orgname
      • //us-parties/inventors/inventor/orgname/
    • XML 4.0, 4.1, 4.2 (first listed is highest preference)
      • //parties/applicants/applicant/addressbook/orgname
      • //parties/applicants/applicant/orgname
    • APS
      • INVT:NAM
  • CITY
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • INVT:CTY
  • COUNTRY
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • INVT:CNT
  • STATE
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • INVT:STA
  • ADDRESS
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • INVT:STR
  • POSTCODE
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • INVT:ZIP

assignments (only strings)

  • LAST_NAME
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //assignees/assignee/addressbook/last-name
      • //assignees/assignee/last-name
    • APS
      • N/A (see ORG_NAME)
  • FIRST_NAME
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //assignees/assignee/addressbook/first-name
      • //assignees/assignee/first-name/
    • APS
      • N/A (see ORG_NAME)
  • ORG_NAME
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //assignees/assignee/addressbook/orgname
      • //assignees/assigneeorgname/
    • APS
      • ASSG:NAM
  • CITY
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • ASSG:CTY
  • COUNTRY
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • ASSG:CNT
  • STATE
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • ASSG:STA
  • ADDRESS
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • ASSG:STR
  • POSTCODE
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • ASSG:ZIP

lawyers (all are strings)

Note in the below queries, for XML results only those XML agent nodes with rep-type="attorney" are looked at.

  • SEQUENCE
    • XML 4.3, 4.4, 4.5
      • //us-parties/agents/agent/sequence
    • XML 4.0, 4.1, 4.2
      • //parties/agents/agent/sequence
  • LAST_NAME
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //us-parties/agents/agent/addressbook/last-name
      • //us-parties/agents/agent/last-name
    • XML 4.0, 4.1, 4.2 (first listed is highest preference)
      • //parties/applicants/applicant/addressbook/last-name
      • //parties/applicants/applicant/last-name
    • APS
      • N/A (see FIRST_NAME)
  • FIRST_NAME
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //us-parties/agents/agent/addressbook/first-name
      • //us-parties/agents/agent/first-name/
    • XML 4.0, 4.1, 4.2 (first listed is highest preference)
      • //parties/agents/agent/addressbook/first-name
      • //parties/agents/agent/first-name
    • APS
      • LREF:NAM (whole name of an individual)
  • ORG_NAME
    • XML 4.3, 4.4, 4.5 (first listed is highest preference)
      • //us-parties/agents/agent/addressbook/orgname
      • //us-parties/agents/agent/orgname/
    • XML 4.0, 4.1, 4.2 (first listed is highest preference)
      • //parties/agents/agent/addressbook/orgname
      • //parties/agents/agent/orgname
    • APS
      • LREF:FRM
  • CITY
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREF:CTY
  • COUNTRY
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREF:CNT
  • STATE
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREF:STA
  • ADDRESS
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREF:STR
  • POSTCODE
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREF:ZIP

Examples

TODO