|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.openxml4j.opc.PackageRelationshipCollection
public final class PackageRelationshipCollection
Represents a collection of PackageRelationship elements that are owned by a given PackagePart or the Package.
Constructor Summary | |
---|---|
PackageRelationshipCollection(OPCPackage container)
Constructor. |
|
PackageRelationshipCollection(OPCPackage container,
PackagePart part)
Constructor. |
|
PackageRelationshipCollection(PackagePart part)
Constructor. |
|
PackageRelationshipCollection(PackageRelationshipCollection coll,
java.lang.String filter)
Copy constructor. |
Method Summary | |
---|---|
void |
addRelationship(PackageRelationship relPart)
Add the specified relationship to the collection. |
PackageRelationship |
addRelationship(java.net.URI targetUri,
TargetMode targetMode,
java.lang.String relationshipType,
java.lang.String id)
Add a relationship to the collection. |
void |
clear()
Clear all relationships. |
PackageRelationship |
getRelationship(int index)
Retrieves a relationship by its index in the collection. |
PackageRelationship |
getRelationshipByID(java.lang.String id)
Retrieves a package relationship based on its id. |
PackageRelationshipCollection |
getRelationships(java.lang.String typeFilter)
Retrieves all relations with the specified type. |
java.util.Iterator<PackageRelationship> |
iterator()
Get this collection's iterator. |
java.util.Iterator<PackageRelationship> |
iterator(java.lang.String typeFilter)
Get an iterator of a collection with all relationship with the specified type. |
void |
removeRelationship(PackageRelationship rel)
Remove a relationship by its reference. |
void |
removeRelationship(java.lang.String id)
Remove a relationship by its ID. |
int |
size()
Get the numbe rof relationships in the collection. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PackageRelationshipCollection(PackageRelationshipCollection coll, java.lang.String filter)
coll
- Collection to import.filter
- Relationship type filter.public PackageRelationshipCollection(OPCPackage container) throws InvalidFormatException
InvalidFormatException
public PackageRelationshipCollection(PackagePart part) throws InvalidFormatException
InvalidFormatException
- Throws if the format of the content part is invalid.
InvalidOperationException
- Throws if the specified part is a relationship part.public PackageRelationshipCollection(OPCPackage container, PackagePart part) throws InvalidFormatException
container
- The parent package.part
- The part that own this relationships collection. If null
then this part is considered as the package root.
InvalidFormatException
- If an error occurs during the parsing of the relatinships
part fo the specified part.Method Detail |
---|
public void addRelationship(PackageRelationship relPart)
relPart
- The relationship to add.public PackageRelationship addRelationship(java.net.URI targetUri, TargetMode targetMode, java.lang.String relationshipType, java.lang.String id)
targetUri
- Target URI.targetMode
- The target mode : INTERNAL or EXTERNALrelationshipType
- Relationship type.id
- Relationship ID.
PackageAccess
public void removeRelationship(java.lang.String id)
id
- The relationship ID to remove.public void removeRelationship(PackageRelationship rel)
rel
- The relationship to delete.public PackageRelationship getRelationship(int index)
index
- Must be a value between [0-relationships_count-1]public PackageRelationship getRelationshipByID(java.lang.String id)
id
- ID of the package relationship to retrieve.
public int size()
public PackageRelationshipCollection getRelationships(java.lang.String typeFilter)
typeFilter
- Relationship type filter. If null then all
relationships are returned.
public java.util.Iterator<PackageRelationship> iterator()
iterator
in interface java.lang.Iterable<PackageRelationship>
public java.util.Iterator<PackageRelationship> iterator(java.lang.String typeFilter)
typeFilter
- Type filter.
public void clear()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |