org.docx4j.openpackaging.parts.relationships

Class RelationshipsPart

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

org.docx4j.openpackaging.parts.JaxbXmlPart<Relationships>

org.docx4j.openpackaging.parts.relationships.RelationshipsPart

public final class RelationshipsPart
extends JaxbXmlPart<Relationships>

Represents a Relationship Part, which contains the relationships for a given PackagePart or the Package.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelationshipsPart.AddPartBehaviour

Field Summary

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

jaxbElement, jc, MAX_BYTES_Unmarshal_Error

Fields inherited from class org.docx4j.openpackaging.parts.Part

pack

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor and Description
RelationshipsPart() You probably don't want this one (though it is useful for reflection).
RelationshipsPart(Base sourceP) Constructor.

Method Summary

Modifier and Type	Method and Description
Relationship	addPart(Part part, RelationshipsPart.AddPartBehaviour mode, ContentTypeManager ctm) Add a newly created part, a relationship and the content type.
Relationship	addPart(Part part, RelationshipsPart.AddPartBehaviour mode, ContentTypeManager ctm, String relId) Add a newly created part, a relationship and the content type.
boolean	addRelationship(Relationship rel) Add the specified relationship to the collection.
static RelationshipsPart	createPackageRels()
static RelationshipsPart	createRelationshipsPartForPart(Base sourcePart)
List<Relationship>	differingContent(RelationshipsPart otherRP) Identify rels common to both parts, but where rels have different content.
String	getNextId()
Part	getPart(Relationship r)
Part	getPart(String id) Gets a loaded Part by its id
PartName	getPartName()
Relationship	getRel(PartName partName) Is partname a target of any of these rels?
Relationship	getRelationshipByID(String id) Retrieves a package relationship based on its id.
static Relationship	getRelationshipByTarget(RelationshipsPart rp, String relativeTarget)
Relationship	getRelationshipByType(String type) Get the first rel with specified relationship type (see Namespaces for pre-defined constants)
Relationships	getRelationships()
List<Relationship>	getRelationshipsByType(String type)
Base	getSourceP()
URI	getSourceURI()
static String	inferSourcePartName(String relationshipsPartName) Infer the source part's name from this rels part name.
void	init()
boolean	isATarget(PartName partName) Deprecated.
boolean	isPackageRelationshipPart() This Relationship Part is the package relationship part if its source is the Package.
boolean	isRelIdOccupied(String relId)
boolean	isTarget(PartName partName, Relationship rel) Is partName the target of the specified rel?
void	loadPart(Part part, Relationship sourceRelationship) Loads a pre-existing target part into the package (but does not load its contents as such; that is done elsewhere).
void	marshal(Node node) Marshal the content tree rooted at jaxbElement into a DOM tree.
void	marshal(OutputStream os) Marshal the content tree rooted at jaxbElement into an output stream, using org.docx4j.jaxb.NamespacePrefixMapper.
List<PartName>	removePart(PartName partName) Remove a part from this package, including its relationships part and all target parts.
List<PartName>	removeParts() Remove all parts from this relationships part
void	removeRelationship(PartName partName)
void	removeRelationship(Relationship rel) Remove a relationship by its reference.
void	removeRelationshipsByType(String type) Remove relationships by type (eg Namespaces.PRESENTATIONML_SLIDE_LAYOUT)
void	resetIdAllocator() Assumes relationship ids are all of the form 'rIdn' where n is a positive integer.
void	setRelationships(Relationships jaxbElement)
void	setSourceP(Base sourcePart)
int	size() Get the number of relationships in the collection.
List<Relationship>	uniqueToOther(RelationshipsPart otherRP) Identify the rels in this relationships part which aren't in the other
List<Relationship>	uniqueToThis(RelationshipsPart otherRP) Identify the rels in this relationships part which aren't in the other
Relationships	unmarshal(Element el)
Relationships	unmarshal(InputStream is) Unmarshal XML data from the specified InputStream and return the resulting content tree.

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

addMcChoiceNamespace, getContents, getJAXBContext, getJaxbElement, getMcChoiceNamespaces, getMceIgnorable, getXML, isContentEqual, isUnmarshalled, marshal, marshal, pipe, pipe, pipe, setContents, setJAXBContext, setJaxbElement, setJaxbElement, setMceIgnorable, transform, variableReplace

Methods inherited from class org.docx4j.openpackaging.parts.Part

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, remove, rename, setContentLengthAsLoaded, setOwningRelationshipPart, setPackage, setPartShortcut, setRelationshipType, setSourceRelationship, setVersion

Methods inherited from class org.docx4j.openpackaging.Base

addTargetPart, addTargetPart, addTargetPart, addTargetPart, getContentType, getRelationshipsPart, getRelationshipsPart, getUserData, reset, setContentType, setPartName, setRelationships, setUserData

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationshipsPart

public RelationshipsPart(Base sourceP)
                  throws InvalidFormatException

Constructor. Creates an appropriately named .rels XML document. Often invoked via sourceP.getRelationshipsPart(true) // create rels part

Parameters:

sourceP - Source part for these relationships

Throws:

InvalidFormatException - If the specified URI is not valid.

RelationshipsPart

public RelationshipsPart()
                  throws InvalidFormatException

You probably don't want this one (though it is useful for reflection). If you do use it, you need to setPartName

Throws:

InvalidFormatException

Method Detail

createPackageRels

public static RelationshipsPart createPackageRels()
                                           throws InvalidFormatException

Returns:

Throws:

InvalidFormatException

Since:

3.2.0, at which time related constructor was made private

init

public void init()

getPartName

public PartName getPartName()

Overrides:

getPartName in class Base

Returns:

the uri

createRelationshipsPartForPart

public static RelationshipsPart createRelationshipsPartForPart(Base sourcePart)

getRelationships

public Relationships getRelationships()

setRelationships

public void setRelationships(Relationships jaxbElement)

getSourceP

public Base getSourceP()

setSourceP

public void setSourceP(Base sourcePart)

getSourceURI

public URI getSourceURI()

isPackageRelationshipPart

public boolean isPackageRelationshipPart()

This Relationship Part is the package relationship part if its source is the Package.

getPart

public Part getPart(String id)

Gets a loaded Part by its id

getRelationshipByID

public Relationship getRelationshipByID(String id)

Retrieves a package relationship based on its id.

Parameters:

id - ID of the package relationship to retrieve.

Returns:

The package relationship identified by the specified id.

getRelationshipByType

public Relationship getRelationshipByType(String type)

Get the first rel with specified relationship type (see Namespaces for pre-defined constants)

Parameters:

type -

Returns:

getRelationshipsByType

public List<Relationship> getRelationshipsByType(String type)

Parameters:

type -

Returns:

Since:

3.3.0

getPart

public Part getPart(Relationship r)

getNextId

public String getNextId()

isRelIdOccupied

public boolean isRelIdOccupied(String relId)

resetIdAllocator

public void resetIdAllocator()

Assumes relationship ids are all of the form 'rIdn' where n is a positive integer.

loadPart

public void loadPart(Part part,
                     Relationship sourceRelationship)

Loads a pre-existing target part into the package (but does not load its contents as such; that is done elsewhere). The target part is assumed to be specified already in this relationship part. Generally this will be used by io.load classes.

Parameters:

part - The part to add.

addPart

public Relationship addPart(Part part,
                            RelationshipsPart.AddPartBehaviour mode,
                            ContentTypeManager ctm)
                     throws InvalidFormatException

Add a newly created part, a relationship and the content type.

Parameters:

part - The part to add.

overwriteExistingTarget - Whether to replace any part with the same target

ctm - Content type manager

Returns:

The Relationship

Throws:

InvalidFormatException

addPart

public Relationship addPart(Part part,
                            RelationshipsPart.AddPartBehaviour mode,
                            ContentTypeManager ctm,
                            String relId)
                     throws InvalidFormatException

Add a newly created part, a relationship and the content type.

Parameters:

part - The part to add.

overwriteExistingTarget - Whether to replace any part with the same target

ctm - Content type manager

relId - the relId we wish to use (provided it is not in use)

Returns:

The Relationship

Throws:

InvalidFormatException

addRelationship

public boolean addRelationship(Relationship rel)
                        throws InvalidOperationException

Add the specified relationship to the collection.

Parameters:

rel - The relationship to add.

Throws:

InvalidOperationException

removeParts

public List<PartName> removeParts()

Remove all parts from this relationships part

removePart

public List<PartName> removePart(PartName partName)

Remove a part from this package, including its relationships part and all target parts. Do so recursively. If this part is relationship part, then delete all relationships in the source part.

Parameters:

partName - The part name of the part to remove.

isATarget

@Deprecated
public boolean isATarget(PartName partName)

Deprecated.

See Also:

getRel

getRel

public Relationship getRel(PartName partName)

Is partname a target of any of these rels?

Parameters:

partName -

Returns:

isTarget

public boolean isTarget(PartName partName,
                        Relationship rel)

Is partName the target of the specified rel?

Parameters:

partName -

rel -

Returns:

Since:

2.6.0

removeRelationship

public void removeRelationship(Relationship rel)

Remove a relationship by its reference.

Parameters:

rel - The relationship to delete.

removeRelationship

public void removeRelationship(PartName partName)

removeRelationshipsByType

public void removeRelationshipsByType(String type)

Remove relationships by type (eg Namespaces.PRESENTATIONML_SLIDE_LAYOUT)

Parameters:

type -

Since:

3.2.0

size

public int size()

Get the number of relationships in the collection.

unmarshal

public Relationships unmarshal(InputStream is)
                        throws JAXBException

Unmarshal XML data from the specified InputStream and return the resulting content tree. Validation event location information may be incomplete when using this form of the unmarshal API.

Implements Unmarshal Global Root Element.

Overrides:

unmarshal in class JaxbXmlPart<Relationships>

Parameters:

is - the InputStream to unmarshal XML data from

Returns:

the newly created root object of the java content tree

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

unmarshal

public Relationships unmarshal(Element el)
                        throws JAXBException

Overrides:

unmarshal in class JaxbXmlPart<Relationships>

Throws:

JAXBException

marshal

public void marshal(Node node)
             throws JAXBException

Description copied from class: JaxbXmlPart

Marshal the content tree rooted at jaxbElement into a DOM tree.

Overrides:

marshal in class JaxbXmlPart<Relationships>

Parameters:

node - DOM nodes will be added as children of this node. This parameter must be a Node that accepts children (Document, DocumentFragment, or Element)

Throws:

JAXBException - If any unexpected problem occurs during the marshalling.

marshal

public void marshal(OutputStream os)
             throws JAXBException

Description copied from class: JaxbXmlPart

Marshal the content tree rooted at jaxbElement into an output stream, using org.docx4j.jaxb.NamespacePrefixMapper.

Overrides:

marshal in class JaxbXmlPart<Relationships>

Parameters:

os - XML will be added to this stream.

Throws:

JAXBException - If any unexpected problem occurs during the marshalling.

uniqueToThis

public List<Relationship> uniqueToThis(RelationshipsPart otherRP)

Identify the rels in this relationships part which aren't in the other

Parameters:

otherRP - the other RelationshipsPart

uniqueToOther

public List<Relationship> uniqueToOther(RelationshipsPart otherRP)

Identify the rels in this relationships part which aren't in the other

Parameters:

otherRP - the other RelationshipsPart

differingContent

public List<Relationship> differingContent(RelationshipsPart otherRP)
                                    throws Docx4JException

Identify rels common to both parts, but where rels have different content.

Parameters:

otherRP -

Returns:

Throws:

Docx4JException

getRelationshipByTarget

public static Relationship getRelationshipByTarget(RelationshipsPart rp,
                                                   String relativeTarget)

inferSourcePartName

public static String inferSourcePartName(String relationshipsPartName)

Infer the source part's name from this rels part name. eg word/_rels/document.xml.rels gives word/document.xml and /_rels/.rels gives /

Parameters:

relationshipsPartName -

Returns: