com.reqdesign.reqif

Class ReferencedFile

java.lang.Object

com.reqdesign.reqif.ReferencedFile

public class ReferencedFile
extends java.lang.Object

Wrapper class for a referenced file which is either the target for an image or an OLE file. An OLE file is any embedded file or non png image. A referenced file can be representational i.e., it is the inner object element in an inner/outer pair.

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	getFullPath() This method returns the String full path to the referenced file for this object
java.lang.String	getMimeType() This method returns the String MIME type of this ReferencedFile object
org.w3c.dom.Element	getObjectElement() This method returns the Element object for this object
org.w3c.dom.Element	getOuterObjectElement() This method returns the Element object for the parent of this object where this object is the representational image
java.lang.String	getRelativePath() This method returns the String relative path of this ReferencedFile object
ReferencedFile	getRepresentationalReferencedFile() This method returns the ReferencedFile object that is the representational image for this object
boolean	isImage() This method returns a Boolean flag indicating whether this object is an image
boolean	isOLE() This method returns a Boolean flag indicating whether this object is an OLE object
boolean	isRepresentational() This method returns a Boolean flag indicating whether this object is a representational image

Methods inherited from class java.lang.Object

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

Method Detail

getRelativePath

public java.lang.String getRelativePath()

This method returns the String relative path of this ReferencedFile object

Returns:

the String relative path of this ReferencedFile object, not null

getMimeType

public java.lang.String getMimeType()

This method returns the String MIME type of this ReferencedFile object

Returns:

the String MIME type of this ReferencedFile object, not null

getRepresentationalReferencedFile

public ReferencedFile getRepresentationalReferencedFile()

This method returns the ReferencedFile object that is the representational image for this object

Returns:

the ReferencedFile object that is the representational image for this object, not null

isRepresentational

public boolean isRepresentational()

This method returns a Boolean flag indicating whether this object is a representational image

Returns:

a Boolean flag indicating whether this object is a representational image

isOLE

public boolean isOLE()

This method returns a Boolean flag indicating whether this object is an OLE object

Returns:

a Boolean flag indicating whether this object is an OLE object

isImage

public boolean isImage()

This method returns a Boolean flag indicating whether this object is an image

Returns:

a Boolean flag indicating whether this object is an image

getObjectElement

public org.w3c.dom.Element getObjectElement()

This method returns the Element object for this object

Returns:

the Element object for this object, not null

getOuterObjectElement

public org.w3c.dom.Element getOuterObjectElement()

This method returns the Element object for the parent of this object where this object is the representational image

Returns:

the Element object for the parent of this object, can be null

getFullPath

public java.nio.file.Path getFullPath()

This method returns the String full path to the referenced file for this object

Returns:

the String full path to the referenced file for this object, not null