Package com.levigo.jadice.document
Interface PageSegmentSource
- All Superinterfaces:
MetadataProvider
,PropertiesProvider
A PageSegmentSource describes the origin of a page segment.
Since
Document
s are not engaged in a 1:1 relation with a single source stream from which
the document was loaded, a document may have many source streams from which its contents are
derived. In contrast to that, AbstractPageSegment
s are usually derived from a single
stream only. However, there are PageSegments which are not derived from a source stream at all.
These PageSegments return null
from a call to their
AbstractPageSegment.getSource()
method.-
Method Summary
Modifier and TypeMethodDescriptionReturn the stream's meta-data.Return the stream's user properties.Return thisPageSegmentSource
's identifying object.
-
Method Details
-
getMetadata
Metadata getMetadata()Return the stream's meta-data.- Specified by:
getMetadata
in interfaceMetadataProvider
- Returns:
- the stream's meta-data.
-
getProperties
Return the stream's user properties.- Specified by:
getProperties
in interfacePropertiesProvider
- Returns:
- a map of user properties
- See Also:
-
getSourceID
SourceID getSourceID()Return thisPageSegmentSource
's identifying object.- Returns:
- an instance of
SourceID
which uniquely identifies thisPageSegmentSource
among allPageSegmentSource
s.
-