org.apache.creadur.whisker.fromxml

Class JDomBuilder

java.lang.Object

org.apache.creadur.whisker.fromxml.JDomBuilder

public class JDomBuilder
extends Object

Builds a model from xml using JDOM.

Constructor Summary

Constructors

Constructor and Description
JDomBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
Descriptor	build(org.jdom.Document document) Builds work from the given document.
Descriptor	build(InputStream xmlStream)
ByOrganisation	byOrganisation(org.jdom.Element byOrganisation, Map<String,Organisation> organisationsById) Builds a by-organisation model from xml.
ByOrganisation	byOrganisation(org.jdom.Element element, Organisation organisation) Builds a by-organisation model from xml.
SortedSet<ByOrganisation>	collectByOrganisations(org.jdom.Element parent, Map<String,Organisation> map) Collects by-organisation children.
Collection<WithinDirectory>	collectContents(org.jdom.Document document, Map<String,License> licenses, Map<String,Organisation> organisations) Collects contents of the document.
Collection<Resource>	collectResources(org.jdom.Element element)
License	license(org.jdom.Element element) Builds a license model from xml.
License	license(org.jdom.Element element, Map<String,License> licenses) Finds the license with an id matching that referenced by the element.
Map<String,License>	mapLicenses(org.jdom.Document document) Collects license definitions within document.
Map<String,String>	mapNotices(org.jdom.Document document) Collects notices in the given documents.
Map<String,Organisation>	mapOrganisations(org.jdom.Document document) Collects organisation definitions within document.
Organisation	organisation(org.jdom.Element element) Builds an organisation model from xml.
Organisation	organisation(org.jdom.Element element, Map<String,Organisation> organisationsById) Finds the organisation linked by ID from the given element.
Map<String,String>	parameters(org.jdom.Element element) Builds a list of parameter values by name.
String	primaryCopyrightNotice(org.jdom.Document document) Gets the additional primary copyright notice from the document.
License	primaryLicense(org.jdom.Document document, Map<String,License> licenses) Finds the primary license for the given document from the given licenses.
String	primaryNotice(org.jdom.Document document) Retrieves the text of the primary notice.
String	primaryOrganisationId(org.jdom.Document document) Retrieves the ID of the primary organisation.
Collection<ByOrganisation>	publicDomain(Map<String,Organisation> organisations, org.jdom.Element parent) Collects child organisations of public domain.
Resource	resource(org.jdom.Element element) Builds a resource.
WithinDirectory	withinDirectory(org.jdom.Element element, Map<String,License> licenses, Map<String,Organisation> organisations) Builds a within directory model from XML.
WithLicense	withLicense(org.jdom.Element element, Map<String,License> licenses, Map<String,Organisation> organisations) Builds a with-license model from xml.
Collection<WithLicense>	withLicenses(Map<String,License> licenses, Map<String,Organisation> organisations, org.jdom.Element parent) Collects child with-licenses.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JDomBuilder

public JDomBuilder()

Method Detail

resource

public Resource resource(org.jdom.Element element)
                  throws UnexpectedElementException

Builds a resource.

Parameters:

element - not null

Returns:

built resource, not null

Throws:

UnexpectedElementException - when element is not named 'resource'

organisation

public Organisation organisation(org.jdom.Element element)
                          throws UnexpectedElementException

Builds an organisation model from xml.

Parameters:

element, - not null

Returns:

Organisation not null

Throws:

UnexpectedElementException - when element is not named 'organisation'

collectResources

public Collection<Resource> collectResources(org.jdom.Element element)

Parameters:

element -

Returns:

organisation

public Organisation organisation(org.jdom.Element element,
                        Map<String,Organisation> organisationsById)
                          throws MissingIDException

Finds the organisation linked by ID from the given element.

Parameters:

element - modelled ByOrganisation, not null

organisationsById - organisations identified, not null

Throws:

MissingIDException - when the linked organisation is not found in the given map

byOrganisation

public ByOrganisation byOrganisation(org.jdom.Element element,
                            Organisation organisation)

Builds a by-organisation model from xml.

Parameters:

element - not null

organisation - not null

Returns:

not null

byOrganisation

public ByOrganisation byOrganisation(org.jdom.Element byOrganisation,
                            Map<String,Organisation> organisationsById)
                              throws MissingIDException

Builds a by-organisation model from xml.

Parameters:

byOrganisation - not null

organisationsById - not null

Returns:

not null

Throws:

MissingIDException - when the linked organisation is not found in the given map

collectByOrganisations

public SortedSet<ByOrganisation> collectByOrganisations(org.jdom.Element parent,
                                               Map<String,Organisation> map)

Collects by-organisation children.

Parameters:

parent - not null

map - not null

Returns:

unmodifiable set sort by natural order, not null

license

public License license(org.jdom.Element element)

Builds a license model from xml.

Parameters:

element - not null

Returns:

not null

license

public License license(org.jdom.Element element,
              Map<String,License> licenses)
                throws MissingIDException

Finds the license with an id matching that referenced by the element.

Parameters:

element - not null

licenses - not null

Returns:

not null

Throws:

MissingIDException - when referenced license isn't found in the collection

withLicense

public WithLicense withLicense(org.jdom.Element element,
                      Map<String,License> licenses,
                      Map<String,Organisation> organisations)
                        throws MissingIDException

Builds a with-license model from xml.

Parameters:

element - not null

licenses - not null

organisations - not null

Returns:

Throws:

MissingIDException - when referenced license isn't found in the collection

parameters

public Map<String,String> parameters(org.jdom.Element element)
                              throws DuplicateElementException

Builds a list of parameter values by name.

Parameters:

element - not null

Returns:

parameter values indexed by value, not null

Throws:

DuplicateElementException - when two parameters shared the same name

withLicenses

public Collection<WithLicense> withLicenses(Map<String,License> licenses,
                                   Map<String,Organisation> organisations,
                                   org.jdom.Element parent)

Collects child with-licenses.

Parameters:

licenses - not null

organisations - not null

parent - not null

Returns:

not null, possibly empty

publicDomain

public Collection<ByOrganisation> publicDomain(Map<String,Organisation> organisations,
                                      org.jdom.Element parent)

Collects child organisations of public domain.

Parameters:

organisations - not null

parent - not null

Returns:

not null, possibly null

withinDirectory

public WithinDirectory withinDirectory(org.jdom.Element element,
                              Map<String,License> licenses,
                              Map<String,Organisation> organisations)

Builds a within directory model from XML.

Parameters:

element - not null

licenses - not null

organisations - not null

Returns:

not null

mapOrganisations

public Map<String,Organisation> mapOrganisations(org.jdom.Document document)

Collects organisation definitions within document.

Parameters:

document, - not null

Returns:

organisations indexed by id, not null possibly empty

mapLicenses

public Map<String,License> mapLicenses(org.jdom.Document document)

Collects license definitions within document.

Parameters:

document, - not null

Returns:

licenses, indexed by id, not null, possibly empty

primaryLicense

public License primaryLicense(org.jdom.Document document,
                     Map<String,License> licenses)

Finds the primary license for the given document from the given licenses.

Parameters:

document - not null

licenses - not null

Returns:

not null

primaryCopyrightNotice

public String primaryCopyrightNotice(org.jdom.Document document)

Gets the additional primary copyright notice from the document.

Parameters:

document - not null

Returns:

optional primary copyright notice, possibly null

mapNotices

public Map<String,String> mapNotices(org.jdom.Document document)

Collects notices in the given documents.

Parameters:

document, - not null

Returns:

notices indexed by id, immutable, not null, possibly empty

primaryNotice

public String primaryNotice(org.jdom.Document document)

Retrieves the text of the primary notice.

Parameters:

document, - not null

Returns:

the text of the primary notice, or null when there is no primary notice

primaryOrganisationId

public String primaryOrganisationId(org.jdom.Document document)

Retrieves the ID of the primary organisation.

Parameters:

document, - not null

Returns:

the id of the primary organisation when set, otherwise null

collectContents

public Collection<WithinDirectory> collectContents(org.jdom.Document document,
                                          Map<String,License> licenses,
                                          Map<String,Organisation> organisations)
                                            throws DuplicateElementException

Collects contents of the document.

Parameters:

document - not null

Returns:

not null, possibly empty

Throws:

DuplicateElementException - when dir names are not unique

build

public Descriptor build(org.jdom.Document document)

Builds work from the given document.

Parameters:

document - not null

Returns:

not null

build

public Descriptor build(InputStream xmlStream)
                 throws org.jdom.JDOMException,
                        IOException

Throws:

org.jdom.JDOMException

IOException