Package com.levigo.jadice.document

Interface PageSegmentSource

All Superinterfaces:

MetadataProvider, PropertiesProvider

public interface PageSegmentSource
extends PropertiesProvider, MetadataProvider

A PageSegmentSource describes the origin of a page segment. Since Documents 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, AbstractPageSegments 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 Type	Method	Description
Metadata	getMetadata()	Return the stream's meta-data.
Map<String,Object>	getProperties()	Return the stream's user properties.
SourceID	getSourceID()	Return this PageSegmentSource's identifying object.

Method Details

getMetadata

Metadata getMetadata()

Return the stream's meta-data.

Specified by:

getMetadata in interface MetadataProvider

Returns:

the stream's meta-data.

getProperties

Map<String,Object> getProperties()

Return the stream's user properties.

Specified by:

getProperties in interface PropertiesProvider

Returns:

a map of user properties

See Also:

• PropertiesProvider

getSourceID

SourceID getSourceID()

Return this PageSegmentSource's identifying object.

Returns:

an instance of SourceID which uniquely identifies this PageSegmentSource among all PageSegmentSources.