IOrigin Class Reference

#include <IOrigin.h>

Inheritance diagram for IOrigin:

Public Member Functions
virtual	~IOrigin ()=default
virtual bool	isReparsable () const
virtual std::string	toString () const =0
virtual std::unique_ptr< RJDocument >	reparse (RJMemoryPoolAlloc &alloc) const
virtual std::unique_ptr< IOrigin >	clone () const =0
virtual bool	operator< (const IOrigin &x) const
bool	operator== (const IOrigin &x) const
virtual bool	operator<= (const IOrigin &x) const
virtual bool	operator> (const IOrigin &x) const
virtual bool	operator>= (const IOrigin &x) const

Detailed Description

IOrigin represents the origin of a Document. It could be a file, a webstream, in-memory, ... This class manages the reparsing (if possible) or documents that have been evicted from memory.

Constructor & Destructor Documentation

~IOrigin()

virtual IOrigin::~IOrigin ( )

virtualdefault

Member Function Documentation

clone()

virtual std::unique_ptr<IOrigin> IOrigin::clone ( ) const

pure virtual

Clones the IOrigin for use in another document

Returns

New IOrigin with the same parameters.

Implemented in IDPositionOrigin, URLOrigin, TemporaryOrigin, and FileOrigin.

isReparsable()

virtual bool IOrigin::isReparsable ( ) const

inlinevirtual

Returns if the IOrigin is reparsable

Returns

true, if yes, false if not

Reimplemented in URLOrigin, TemporaryOrigin, IDPositionOrigin, and FileOrigin.

Here is the caller graph for this function:

operator<()

virtual bool IOrigin::operator< ( const IOrigin &  x ) const

inlinevirtual

Reimplemented in IDPositionOrigin.

operator<=()

virtual bool IOrigin::operator<= ( const IOrigin &  x ) const

inlinevirtual

operator==()

bool IOrigin::operator== ( const IOrigin &  x ) const

inline

operator>()

virtual bool IOrigin::operator> ( const IOrigin &  x ) const

inlinevirtual

operator>=()

virtual bool IOrigin::operator>= ( const IOrigin &  x ) const

inlinevirtual

reparse()

virtual std::unique_ptr<RJDocument> IOrigin::reparse ( RJMemoryPoolAlloc &  alloc ) const

inlinevirtual

Reparses the origin into a new RJDocument. The allocator is used to increase performance

Parameters

alloc

Allocator used for allocating memoty

Returns

Reparsed RJDocument, or nullpointer if not reparsable

Reimplemented in URLOrigin, IDPositionOrigin, and FileOrigin.

Here is the call graph for this function:

toString()

virtual std::string IOrigin::toString ( ) const

pure virtual

Returns a textual representation of the IOrigin

Returns

Implemented in IDPositionOrigin, URLOrigin, TemporaryOrigin, and FileOrigin.

---

The documentation for this class was generated from the following file:

• /home/nico/joda_tmp/tmp-joda-dirs/JODA-gh/libs/joda/core/modules/storage/document/include/joda/document/IOrigin.h