org.apache.poi

Class POIXMLRelation

java.lang.Object

org.apache.poi.POIXMLRelation

Direct Known Subclasses:

XSLFRelation, XSSFRelation, XWPFRelation

public abstract class POIXMLRelation
extends Object

Represents a descriptor of a OOXML relation.

Author:

Yegor Kozlov

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_defaultName The path component of a pack URI.
protected String	_relation The kind of connection between a source part and a target part in a package.
protected String	_type Describes the content stored in a part.

Constructor Summary

Constructors

Constructor and Description
POIXMLRelation(String type, String rel, String defaultName) Instantiates a POIXMLRelation.
POIXMLRelation(String type, String rel, String defaultName, Class<? extends POIXMLDocumentPart> cls) Instantiates a POIXMLRelation.

Method Summary

Methods

Modifier and Type	Method and Description
String	getContentType() Return the content type.
String	getDefaultFileName() Return the default part name.
String	getFileName(int index) Returns the filename for the nth one of these, e.g.
String	getRelation() Return the relationship, the kind of connection between a source part and a target part in a package.
Class<? extends POIXMLDocumentPart>	getRelationClass() Return type of the obejct used to construct instances of this relationship

Methods inherited from class java.lang.Object

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

Field Detail

_type

protected String _type

Describes the content stored in a part.

_relation

protected String _relation

The kind of connection between a source part and a target part in a package.

_defaultName

protected String _defaultName

The path component of a pack URI.

Constructor Detail

POIXMLRelation

public POIXMLRelation(String type,
              String rel,
              String defaultName,
              Class<? extends POIXMLDocumentPart> cls)

Instantiates a POIXMLRelation.

Parameters:

type - content type

rel - relationship

defaultName - default item name

cls - defines what object is used to construct instances of this relationship

POIXMLRelation

public POIXMLRelation(String type,
              String rel,
              String defaultName)

Instantiates a POIXMLRelation.

Parameters:

type - content type

rel - relationship

defaultName - default item name

Method Detail

getContentType

public String getContentType()

Return the content type. Content types define a media type, a subtype, and an optional set of parameters, as defined in RFC 2616.

Returns:

the content type

getRelation

public String getRelation()

Return the relationship, the kind of connection between a source part and a target part in a package. Relationships make the connections between parts directly discoverable without looking at the content in the parts, and without altering the parts themselves.

Returns:

the relationship

getDefaultFileName

public String getDefaultFileName()

Return the default part name. Part names are used to refer to a part in the context of a package, typically as part of a URI.

Returns:

the default part name

getFileName

public String getFileName(int index)

Returns the filename for the nth one of these, e.g. /xl/comments4.xml

getRelationClass

public Class<? extends POIXMLDocumentPart> getRelationClass()

Return type of the obejct used to construct instances of this relationship

Returns:

the class of the object used to construct instances of this relation