org.schwa.dr
Interface Ann

All Known Subinterfaces:

Doc

All Known Implementing Classes:

AbstractAnn, AbstractDoc

public interface Ann

Base interface for all annotation types. The methods provided here are mainly usedful within this package, providing internal methods for implementing laziness and other docrep things.

Author:

Tim Dawborn

Method Summary

Integer	getDRIndex() If this annotation instance is stored within a Store, this method returns the index of this annotation within the store.
byte[]	getDRLazy() If this annotation has lazily stored attribute data, returns the lazy data as an array of bytes ready for serialisation.
int	getDRLazyNElem() If this annotaiton has lazily stored attribute data, returns the number of lazily stored fields.
void	setDRIndex(Integer index) Sets the index of this annotation instance within its containing store.
void	setDRLazy(byte[] lazy) Sets the lazily stored attribute data for this annotation instance.
void	setDRLazyNElem(int lazyNElem) Sets the number of lazily stored fields for this annotation instance.

Method Detail

getDRIndex

Integer getDRIndex()

If this annotation instance is stored within a Store, this method returns the index of this annotation within the store. If this annotation does not belong to any store, this method returns null.

getDRLazy

byte[] getDRLazy()

If this annotation has lazily stored attribute data, returns the lazy data as an array of bytes ready for serialisation. If not, this method returns null.

getDRLazyNElem

int getDRLazyNElem()

If this annotaiton has lazily stored attribute data, returns the number of lazily stored fields. If not, this method returns zero.

setDRIndex

void setDRIndex(Integer index)

Sets the index of this annotation instance within its containing store.

setDRLazy

void setDRLazy(byte[] lazy)

Sets the lazily stored attribute data for this annotation instance.

setDRLazyNElem

void setDRLazyNElem(int lazyNElem)

Sets the number of lazily stored fields for this annotation instance.