ossimKakaduReaderFactory Class Reference

Factory for J2K image reader. More...

#include <ossimKakaduReaderFactory.h>

Inheritance diagram for ossimKakaduReaderFactory:

Public Member Functions
virtual	~ossimKakaduReaderFactory ()
	virtual destructor More...
virtual ossimImageHandler *	open (const ossimFilename &fileName, bool openOverview=true) const
	open that takes a file name. More...
virtual ossimImageHandler *	open (const ossimKeywordlist &kwl, const char *prefix=0) const
	Open overview that takes a file name. More...
virtual ossimRefPtr< ossimImageHandler >	open (std::shared_ptr< ossim::istream > &str, const std::string &connectionString, bool openOverview) const
	Open method that takes a stream. More...
virtual ossimRefPtr< ossimImageHandler >	openOverview (const ossimFilename &file) const
	Open overview that takes a file name. More...
virtual ossimRefPtr< ossimImageHandler >	openOverview (std::shared_ptr< ossim::istream > &str, const ossimString &connectionString) const
	Open method that takes a stream. More...
virtual ossimObject *	createObject (const ossimString &typeName) const
	createObject that takes a class name (ossimKakaduReader) More...
virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const
	Creates and object given a keyword list and prefix. More...
virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	Adds ossimKakaduWriter to the typeList. More...
virtual void	getSupportedExtensions (ossimImageHandlerFactoryBase::UniqueStringList &extensionList) const
	Method to add supported extension to the list, like "jp2". More...
virtual void	getImageHandlersBySuffix (ossimImageHandlerFactoryBase::ImageHandlerList &result, const ossimString &ext) const
	Will add to the result list any handler that supports the passed in extensions. More...
virtual void	getImageHandlersByMimeType (ossimImageHandlerFactoryBase::ImageHandlerList &result, const ossimString &mimeType) const
	Will add to the result list and handler that supports the passed in mime type. More...
Public Member Functions inherited from ossimImageHandlerFactoryBase
virtual ossimRefPtr< ossimImageHandler >	open (std::shared_ptr< ossim::ImageHandlerState > state) const
Public Member Functions inherited from ossimObjectFactory
virtual	~ossimObjectFactory ()
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Static Public Member Functions
static ossimKakaduReaderFactory *	instance ()
	static method to return instance (the only one) of this class. More...

Protected Member Functions
bool	hasExcludedExtension (const ossimFilename &file) const
	Method to weed out extensions that this plugin knows it does not support. More...
	ossimKakaduReaderFactory ()
	hidden from use default constructor More...
	ossimKakaduReaderFactory (const ossimKakaduReaderFactory &)
	hidden from use copy constructor More...
void	operator= (const ossimKakaduReaderFactory &)
	hidden from use copy constructor More...
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Additional Inherited Members
Public Types inherited from ossimImageHandlerFactoryBase
typedef UniqueList< ossimString >	UniqueStringList
typedef std::vector< ossimRefPtr< ossimImageHandler > >	ImageHandlerList

Detailed Description

Factory for J2K image reader.

Definition at line 21 of file ossimKakaduReaderFactory.h.

Constructor & Destructor Documentation

~ossimKakaduReaderFactory()

ossimKakaduReaderFactory::~ossimKakaduReaderFactory ( )

virtual

virtual destructor

Definition at line 30 of file ossimKakaduReaderFactory.cpp.

{
}

ossimKakaduReaderFactory() [1/2]

ossimKakaduReaderFactory::ossimKakaduReaderFactory ( )

protected

hidden from use default constructor

Definition at line 309 of file ossimKakaduReaderFactory.cpp.

{}

ossimKakaduReaderFactory() [2/2]

ossimKakaduReaderFactory::ossimKakaduReaderFactory ( const ossimKakaduReaderFactory &  )

protected

hidden from use copy constructor

Definition at line 311 of file ossimKakaduReaderFactory.cpp.

{}

Member Function Documentation

createObject() [1/2]

ossimObject * ossimKakaduReaderFactory::createObject ( const ossimString &  typeName ) const

virtual

createObject that takes a class name (ossimKakaduReader)

Parameters

typeName

Should be "ossimKakaduReader".

Returns

pointer to image writer on success, NULL on failure.

Implements ossimObjectFactory.

Definition at line 208 of file ossimKakaduReaderFactory.cpp.

References ossimRefPtr< T >::release().

{
   ossimRefPtr<ossimObject> result = 0;
   if(typeName == "ossimKakaduNitfReader")
   {
      result = new ossimKakaduNitfReader;
   }
   else if(typeName == "ossimKakaduJp2Reader")
   {
      result = new ossimKakaduJp2Reader;
   }
   else if(typeName == "ossimKakaduJ2kReader")
   {
      result =  new ossimKakaduJ2kReader;
   }
   return result.release();
}

createObject() [2/2]

ossimObject * ossimKakaduReaderFactory::createObject ( const ossimKeywordlist &  kwl, const char *  prefix = 0  ) const

virtual

Creates and object given a keyword list and prefix.

Parameters

kwl	The keyword list.
prefix	the keyword list prefix.

Returns

pointer to image handler on success, NULL on failure.

Implements ossimObjectFactory.

Definition at line 226 of file ossimKakaduReaderFactory.cpp.

References open().

{
   return this->open(kwl, prefix);
}

getImageHandlersByMimeType()

void ossimKakaduReaderFactory::getImageHandlersByMimeType ( ossimImageHandlerFactoryBase::ImageHandlerList &  result, const ossimString &  mimeType  ) const

virtual

Will add to the result list and handler that supports the passed in mime type.

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 290 of file ossimKakaduReaderFactory.cpp.

References ossimString::begin(), ossimString::end(), and ossimString::push_back().

{
   ossimString test(mimeType.begin(), mimeType.begin()+6);
   if(test == "image/")
   {
      ossimString mimeTypeTest(mimeType.begin() + 6, mimeType.end());
      if(mimeTypeTest == "jp2")
      {
         result.push_back(new ossimKakaduJp2Reader);
      }
      else if(mimeTypeTest == "nitf")
      {
         result.push_back(new ossimKakaduNitfReader);
      }
   }
}

getImageHandlersBySuffix()

void ossimKakaduReaderFactory::getImageHandlersBySuffix ( ossimImageHandlerFactoryBase::ImageHandlerList &  result, const ossimString &  ext  ) const

virtual

Will add to the result list any handler that supports the passed in extensions.

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 268 of file ossimKakaduReaderFactory.cpp.

References ossimString::downcase(), and ossimString::push_back().

{
   ossimString testExt = ext.downcase();
   if(testExt == "jp2")
   {
      result.push_back(new ossimKakaduJp2Reader);
   }
   else if(testExt == "ntf")
   {
      result.push_back(new ossimKakaduNitfReader);
   }
   else if(testExt == "nitf")
   {
      result.push_back(new ossimKakaduNitfReader);
   }
}

getSupportedExtensions()

void ossimKakaduReaderFactory::getSupportedExtensions ( ossimImageHandlerFactoryBase::UniqueStringList &  extensionList ) const

virtual

Method to add supported extension to the list, like "jp2".

Parameters

extensionList

The list to add to.

Implements ossimImageHandlerFactoryBase.

Definition at line 241 of file ossimKakaduReaderFactory.cpp.

References ossimImageHandlerFactoryBase::UniqueList< T >::push_back().

{
   extensionList.push_back(ossimString("j2k"));
   extensionList.push_back(ossimString("jp2"));   
}

getTypeNameList()

void ossimKakaduReaderFactory::getTypeNameList ( std::vector< ossimString > &  typeList ) const

virtual

Adds ossimKakaduWriter to the typeList.

Parameters

typeList

List to add to.

Implements ossimObjectFactory.

Definition at line 233 of file ossimKakaduReaderFactory.cpp.

{
   typeList.push_back(ossimString("ossimKakaduNitfReader"));
   typeList.push_back(ossimString("ossimKakaduJp2Reader"));
   typeList.push_back(ossimString("ossimKakaduJ2kReader"));
}

hasExcludedExtension()

bool ossimKakaduReaderFactory::hasExcludedExtension ( const ossimFilename &  file ) const

protected

Method to weed out extensions that this plugin knows it does not support.

This is to avoid a costly open on say a tiff or jpeg that is not handled by this plugin.

Returns

true if extension, false if not.

Definition at line 248 of file ossimKakaduReaderFactory.cpp.

References ossimString::downcase(), and ossimFilename::ext().

{
   bool result = false;
   ossimString ext = file.ext().downcase();
   if ( (ext == "tif")  ||
        (ext == "tiff") ||
        (ext == "jpg")  ||
        (ext == "jpeg") ||
        (ext == "png") )
   {
      result = true;
   }
   return result;
}

instance()

ossimKakaduReaderFactory * ossimKakaduReaderFactory::instance ( )

static

static method to return instance (the only one) of this class.

Returns

pointer to instance of this class.

Definition at line 34 of file ossimKakaduReaderFactory.cpp.

Referenced by ossimSharedLibraryFinalize(), and ossimSharedLibraryInitialize().

{
   static ossimKakaduReaderFactory inst;
   return &inst;
}

open() [1/3]

ossimImageHandler * ossimKakaduReaderFactory::open ( const ossimFilename &  fileName, bool  openOverview = true  ) const

virtual

open that takes a file name.

Parameters

file	The file to open.
openOverview	If true image handler will attempt to open overview. default = true

Returns

pointer to image handler on success, NULL on failure.

Implements ossimImageHandlerFactoryBase.

Definition at line 40 of file ossimKakaduReaderFactory.cpp.

Referenced by createObject().

{
   static const char* M = "ossimKakaduReaderFactory::open(filename) -- ";
   if(traceDebug())
      ossimNotify(ossimNotifyLevel_DEBUG)<<M<<"Entered with filename <"<<fileName<<">"  ;

   ossimRefPtr<ossimImageHandler> reader = 0; 
   while (true)
   {
      if (hasExcludedExtension(fileName))  break;

      if (traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG)<<M<< "Trying ossimKakaduNitfReader...";
      reader = new ossimKakaduNitfReader;
      reader->setOpenOverviewFlag(openOverview);
      if(reader->open(fileName))  break;

      if (traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG)<<M<< "Trying ossimKakaduJp2Reader...";
      reader = new ossimKakaduJp2Reader;
      reader->setOpenOverviewFlag(openOverview);
      if(reader->open(fileName))  break;

      if (traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG)<<M<< "Trying ossimKakaduJ2kReader...";
      reader = new ossimKakaduJ2kReader;
      reader->setOpenOverviewFlag(openOverview);
      if(reader->open(fileName))  break;

      reader = 0;
      break;
   } 
   
   if (traceDebug())
   {
      if (reader.valid())
         ossimNotify(ossimNotifyLevel_DEBUG)<<M<< "   SUCCESS" << std::endl;
      else
         ossimNotify(ossimNotifyLevel_DEBUG)<<M<< "   Open FAILED" << std::endl;
   }
 
   return reader.release();
}

open() [2/3]

ossimImageHandler * ossimKakaduReaderFactory::open ( const ossimKeywordlist &  kwl, const char *  prefix = 0  ) const

virtual

Open overview that takes a file name.

Parameters

file	File to open.

Returns

ossimRefPtr to image handler on success or null on failure.

Implements ossimImageHandlerFactoryBase.

Definition at line 82 of file ossimKakaduReaderFactory.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimKakaduReaderFactory::open(kwl, prefix) DEBUG: entered..."
         << std::endl;
   }

   ossimRefPtr<ossimImageHandler> reader = 0; 

   // To save time check the file name first.
   const char* lookup = kwl.find(prefix, ossimKeywordNames::FILENAME_KW);
   if (!lookup)
   {
      // Deprecated...
      lookup = kwl.find(prefix, ossimKeywordNames::IMAGE_FILE_KW);
   }

   if (lookup)
   {
      ossimFilename f = lookup;
      if ( hasExcludedExtension(f) == false )
      {
         reader = new ossimKakaduNitfReader;
         if(reader->loadState(kwl, prefix) == false)
         {
            reader = 0;
         }
         
         if (!reader)
         {
            reader = new ossimKakaduJp2Reader;
            if(reader->loadState(kwl, prefix) == false)
            {
               reader = 0;
            }
         }
         
         if (!reader)
         {
            reader = new ossimKakaduJ2kReader;
            if(reader->loadState(kwl, prefix) == false)
            {
               reader = 0;
            }
         }
      }
   }

   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimKakaduReaderFactory::open(kwl, prefix) DEBUG: leaving..."
         << std::endl;
   }
   
   return reader.release();
}

open() [3/3]

ossimRefPtr< ossimImageHandler > ossimKakaduReaderFactory::open ( std::shared_ptr< ossim::istream > &  str, const std::string &  connectionString, bool  openOverview  ) const

virtual

Open method that takes a stream.

This implementation returns an ossimRefPtr with a null pointer.

Parameters

str	Open stream to image.
connectionString
openOverview	If true attempt to open overview file.

Returns

ossimImageHandler

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 143 of file ossimKakaduReaderFactory.cpp.

References ossimRefPtr< T >::get(), ossimNitfTileSource::open(), openOverview(), and ossimImageHandler::setOpenOverviewFlag().

{
   ossimRefPtr<ossimImageHandler> result(0);

   // J2K NITF:
   ossimRefPtr<ossimKakaduNitfReader> ih = new ossimKakaduNitfReader();
   ih->setOpenOverviewFlag(openOverview);
   if ( ih->open( str, connectionString ) )
   {
      result = ih.get();
   }
   else
   {
      // Reset the stream for downstream code.
      str->seekg(0, std::ios_base::beg);
      str->clear();
   }

   return result;
}

openOverview() [1/2]

ossimRefPtr< ossimImageHandler > ossimKakaduReaderFactory::openOverview ( const ossimFilename &  file ) const

virtual

Open overview that takes a file name.

Parameters

file	File to open.

Returns

ossimRefPtr to image handler on success or null on failure.

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 168 of file ossimKakaduReaderFactory.cpp.

References ossimImageHandler::open(), ossimImageHandler::setOpenOverviewFlag(), and ossimString::size().

Referenced by open().

{
   ossimRefPtr<ossimImageHandler> result = 0;
   if ( file.size() )
   {
      result = new ossimKakaduNitfReader;

      result->setOpenOverviewFlag( false ); // Always false...

      if( result->open( file ) == false )
      {
         result = 0;
      }
   }
   return result;
}

openOverview() [2/2]

ossimRefPtr< ossimImageHandler > ossimKakaduReaderFactory::openOverview ( std::shared_ptr< ossim::istream > &  str, const ossimString &  connectionString  ) const

virtual

Open method that takes a stream.

Parameters

str	Open stream to image.
connectionString

Returns

ossimImageHandler

Reimplemented from ossimImageHandlerFactoryBase.

Definition at line 186 of file ossimKakaduReaderFactory.cpp.

References ossimRefPtr< T >::get(), ossimNitfTileSource::open(), and ossimImageHandler::setOpenOverviewFlag().

{
   ossimRefPtr<ossimImageHandler> result(0);

   // J2K NITF:
   ossimRefPtr<ossimKakaduNitfReader> ih = new ossimKakaduNitfReader();
   ih->setOpenOverviewFlag(false);
   if ( ih->open( str, connectionString ) )
   {
      result = ih.get();
   }
   else
   {
      // Reset the stream for downstream code.
      str->seekg(0, std::ios_base::beg);
      str->clear();
   }

   return result;
}

operator=()

void ossimKakaduReaderFactory::operator= ( const ossimKakaduReaderFactory &  )

protected

hidden from use copy constructor

Definition at line 313 of file ossimKakaduReaderFactory.cpp.

{}

---

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

• ossimKakaduReaderFactory.h
• ossimKakaduReaderFactory.cpp