Uses of Class
org.gedcomx.Gedcomx

Packages that use Gedcomx

Package	Description
org.gedcomx	The base GEDCOM X data format.
org.gedcomx.records	The sources model.
org.gedcomx.rt
org.gedcomx.util

Uses of Gedcomx in org.gedcomx

Methods in org.gedcomx that return Gedcomx

Modifier and Type	Method and Description
Gedcomx	Gedcomx.addMainPersonDescription() Add a description for the main person in this document.
Gedcomx	Gedcomx.addPersonDescription(Person person, Date lastModified, DateFormat dateFormat, String version, URI collectionUri) Add a description for the person in this document.
Gedcomx	Gedcomx.agent(Agent agent) Build this out with a agent.
Gedcomx	Gedcomx.attribution(Attribution attribution) Build this out with an attribution.
Gedcomx	Gedcomx.collection(Collection collection) Build this out with a collection.
Gedcomx	Gedcomx.descriptionRef(URI descriptionRef) Build out this with a description ref.
Gedcomx	Gedcomx.document(Document document) Build this out with a document.
Gedcomx	Gedcomx.event(Event event) Build this out with a event.
Gedcomx	Gedcomx.field(Field field) Build this out with a field.
Gedcomx	Gedcomx.fixLocalReferences() Fixes all references to entities that are in the document to be local references.
Gedcomx	Gedcomx.lang(String lang) Build out this envelope with a lang.
Gedcomx	Gedcomx.person(Person person) Build this out with a person.
Gedcomx	Gedcomx.place(PlaceDescription place) Build this out with a place.
Gedcomx	Gedcomx.recordDescriptor(RecordDescriptor recordDescriptor) Build this out with a record descriptor.
Gedcomx	Gedcomx.relationship(Relationship relationship) Build this out with a relationship.
Gedcomx	Gedcomx.sourceDescription(SourceDescription sourceDescription) Build this out with a source description.

Methods in org.gedcomx with parameters of type Gedcomx

Modifier and Type	Method and Description
void	Gedcomx.embed(Gedcomx gedcomx)

Uses of Gedcomx in org.gedcomx.records

Methods in org.gedcomx.records that return Gedcomx

Modifier and Type	Method and Description
Gedcomx	RecordSet.getMetadata() Metadata about this record set; shared among all records in the set.

Methods in org.gedcomx.records that return types with arguments of type Gedcomx

Modifier and Type	Method and Description
List<Gedcomx>	RecordSet.getRecords() The records included in this genealogical data set.
Stream<Gedcomx>	RecordSet.records() Create a stream for the records.

Methods in org.gedcomx.records with parameters of type Gedcomx

Modifier and Type	Method and Description
RecordSet	RecordSet.metadata(Gedcomx metadata) Build out this record set with metadata.
RecordSet	RecordSet.record(Gedcomx record) Build out this record set with a record.
void	RecordSet.setMetadata(Gedcomx metadata) Metadata about this record set; shared among all records in the set.

Method parameters in org.gedcomx.records with type arguments of type Gedcomx

Modifier and Type	Method and Description
void	RecordSet.setRecords(List<Gedcomx> records) The records included in this genealogical data set.

Uses of Gedcomx in org.gedcomx.rt

Methods in org.gedcomx.rt with parameters of type Gedcomx

Modifier and Type	Method and Description
static ExtensibleData	GedcomxLocalReferenceResolver.resolve(ResourceReference ref, Gedcomx document)
static ExtensibleData	GedcomxLocalReferenceResolver.resolve(String resourceId, Gedcomx document)
static ExtensibleData	GedcomxLocalReferenceResolver.resolve(URI ref, Gedcomx document)
void	GedcomxLocalReferenceResolver.visitGedcomx(Gedcomx gx)
void	GedcomxModelVisitorBase.visitGedcomx(Gedcomx gx)
void	GedcomxModelVisitor.visitGedcomx(Gedcomx gx)

Uses of Gedcomx in org.gedcomx.util

Methods in org.gedcomx.util that return Gedcomx

Modifier and Type	Method and Description
Gedcomx	FieldMap.getCollection() Get the GedcomX document for the collection that the record is found in.
Gedcomx	DocMap.getDocument() Get the Gedcomx document that was used to create this DocMap.
Gedcomx	RecordSetIterator.getMetadata() Retrieve the metadata for the RecordSet.
Gedcomx	XmlRecordSetIterator.getMetadata()
Gedcomx	JsonRecordSetIterator.getMetadata() This should be read last as you cannot be sure of when the metadata will appear in the data stream.
Gedcomx	FieldMap.getRecord() Get the GedcomX document for the record.
Gedcomx	RecordSetIterator.next() Get the next Gedcomx Record from the RecordSet.
Gedcomx	XmlRecordSetIterator.next()
Gedcomx	JsonRecordSetIterator.next()

Methods in org.gedcomx.util with parameters of type Gedcomx

Modifier and Type	Method and Description
static String	DocCheck.checkDocument(Gedcomx doc) Check a GedcomX document for problems.
static String	DocCheck.checkDocument(Gedcomx doc, Gedcomx collection) Check a GedcomX document for problems.
static String	DocCheck.checkRecordSet(RecordSet records, Gedcomx collection) Check a GedcomX RecordSet for problems.
static Map<String,Agent>	DocMap.getAgentMap(Gedcomx doc) Create a map of local id (and "#" + id) to the Agent that has that id.
static List<Field>	FieldMap.getAllFields(Gedcomx record) Create a list of all of the fields occurring in the given GedcomX record, including those found within the various values.
static Map<Person,List<Field>>	FieldMap.getPersonFieldMap(Gedcomx record) Get a map of Person to the list of Fields for that person.
static Map<String,Person>	DocMap.getPersonMap(Gedcomx doc) Create a map of local id (and "#" + id) as well as all person identifiers to the local Person object with that id or identifier.
static Map<String,PlaceDescription>	DocMap.getPlaceMap(Gedcomx doc) Create a map of local id (and "#" + id) and identifier URIs to the PlaceDescription that has that id or URL.
static Map<String,RecordDescriptor>	DocMap.getRecordDescriptorMap(Gedcomx doc) Create a map of local id (and "#" + id) to the RecordDescriptor that has that id.
static Map<String,SourceDescription>	DocMap.getSourceDescriptionMap(Gedcomx doc) Create a map of id (and "#" + id) and all identifier URI strings to SourceDescription with that ID, to make it easier to look up SourceDescriptions that are referenced elsewhere.
static boolean	FieldMap.isCensus(Gedcomx record) Tell whether the given record is a Census record, i.e., if it has a SourceDescription with a Coverage with a RecordType of Census.
void	RecordSetWriter.setMetadata(Gedcomx metadata) Set the 'metadata' document, which will be written after all of the records.
void	DocMap.update(Gedcomx doc) Update the maps with the given GedcomX document (e.g., when the document has changed).
void	RecordSetWriter.writeRecord(Gedcomx record) Write the given record to the underlying byte-level (and possibly GZipped) output stream.
void	JsonRecordSetWriter.writeRecord(Gedcomx record)

Constructors in org.gedcomx.util with parameters of type Gedcomx

Constructor and Description
DocMap(Gedcomx doc) Constructor.
FieldMap(Gedcomx record, Gedcomx collection) Constructor for a collection and record GedcomX document.
JsonRecordSetWriter(OutputStream outputStream, Gedcomx metadata) Constructor.