ossimKakaduJpipHandlerFactory Class Reference

Factory for J2K image reader. More...

#include <ossimKakaduJpipHandlerFactory.h>

Inheritance diagram for ossimKakaduJpipHandlerFactory:

Public Member Functions
virtual	~ossimKakaduJpipHandlerFactory ()
	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 that takes a keyword list and prefix. 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::istream > &str, const std::string &connectionString, bool openOverview=true) const
	Open method that takes a stream. More...
virtual ossimRefPtr< ossimImageHandler >	open (std::shared_ptr< ossim::ImageHandlerState > state) const
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...
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 ossimKakaduJpipHandlerFactory *	instance ()
	static method to return instance (the only one) of this class. More...

Protected Member Functions
	ossimKakaduJpipHandlerFactory ()
	Method to weed out extensions that this plugin knows it does not support. More...
	ossimKakaduJpipHandlerFactory (const ossimKakaduJpipHandlerFactory &)
	hidden from use copy constructor More...
void	operator= (const ossimKakaduJpipHandlerFactory &)
	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 ossimKakaduJpipHandlerFactory.h.

Constructor & Destructor Documentation

~ossimKakaduJpipHandlerFactory()

ossimKakaduJpipHandlerFactory::~ossimKakaduJpipHandlerFactory ( )

virtual

virtual destructor

Definition at line 29 of file ossimKakaduJpipHandlerFactory.cpp.

{
}

ossimKakaduJpipHandlerFactory() [1/2]

ossimKakaduJpipHandlerFactory::ossimKakaduJpipHandlerFactory ( )

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.hidden from use default constructor

Definition at line 221 of file ossimKakaduJpipHandlerFactory.cpp.

{}

ossimKakaduJpipHandlerFactory() [2/2]

ossimKakaduJpipHandlerFactory::ossimKakaduJpipHandlerFactory ( const ossimKakaduJpipHandlerFactory &  )

protected

hidden from use copy constructor

Definition at line 223 of file ossimKakaduJpipHandlerFactory.cpp.

{}

Member Function Documentation

createObject() [1/2]

ossimObject * ossimKakaduJpipHandlerFactory::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 168 of file ossimKakaduJpipHandlerFactory.cpp.

References ossimRefPtr< T >::release(), and STATIC_TYPE_NAME.

{
   ossimRefPtr<ossimObject> result = 0;
   
   if(typeName == STATIC_TYPE_NAME(ossimKakaduJpipHandler))
   {
      result =  new ossimKakaduJpipHandler();
   }
   
   return result.release();
}

createObject() [2/2]

ossimObject * ossimKakaduJpipHandlerFactory::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 180 of file ossimKakaduJpipHandlerFactory.cpp.

References open().

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

getImageHandlersByMimeType()

void ossimKakaduJpipHandlerFactory::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 215 of file ossimKakaduJpipHandlerFactory.cpp.

{
}

getImageHandlersBySuffix()

void ossimKakaduJpipHandlerFactory::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 200 of file ossimKakaduJpipHandlerFactory.cpp.

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

{
    ossimString testExt = ext.downcase();
   if((testExt == "jp2")||(testExt=="jp2"))
   {
      result.push_back(new ossimKakaduJpipHandler());
   }
}

getSupportedExtensions()

void ossimKakaduJpipHandlerFactory::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 193 of file ossimKakaduJpipHandlerFactory.cpp.

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

{
   extensionList.push_back("jp2");
   extensionList.push_back("jpip");
}

getTypeNameList()

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

virtual

Adds ossimKakaduWriter to the typeList.

Parameters

typeList

List to add to.

Implements ossimObjectFactory.

Definition at line 187 of file ossimKakaduJpipHandlerFactory.cpp.

References STATIC_TYPE_NAME.

{
   typeList.push_back(STATIC_TYPE_NAME(ossimKakaduJpipHandler));
}

instance()

ossimKakaduJpipHandlerFactory * ossimKakaduJpipHandlerFactory::instance ( )

static

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

Returns

pointer to instance of this class.

Definition at line 33 of file ossimKakaduJpipHandlerFactory.cpp.

Referenced by ossimSharedLibraryInitialize().

{
   static ossimKakaduJpipHandlerFactory inst;
   return &inst;
}

open() [1/2]

ossimImageHandler * ossimKakaduJpipHandlerFactory::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 39 of file ossimKakaduJpipHandlerFactory.cpp.

Referenced by createObject().

{
   static const char* M = "ossimKakaduJpipHandlerFactory::open(filename) -- ";
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)<<M<<"Entered with filename <"<<fileName<<">\n" ;
   }
   
   ossimRefPtr<ossimImageHandler> reader = 0; 
   
   if (traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG)<<M<< "Trying ossimKakaduJpipHandler...";
   reader = new ossimKakaduJpipHandler();
   reader->setOpenOverviewFlag(openOverview);
   if(!reader->open(fileName))
   {
      reader = 0;
   }
   
   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/2]

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

virtual

open that takes 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 ossimImageHandlerFactoryBase.

Definition at line 69 of file ossimKakaduJpipHandlerFactory.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimKakaduJpipHandlerFactory::open(kwl, prefix) DEBUG: entered..."
         << std::endl;
   }
   ossimRefPtr<ossimImageHandler> reader = 0; 
   const char* lookup = kwl.find(prefix, ossimKeywordNames::TYPE_KW);
   const char* filenameLookup = kwl.find(prefix, ossimKeywordNames::FILENAME_KW);
   const char* urlLookup = kwl.find(prefix, "url");
   
   ossimRefPtr<ossimObject> obj;
   // first check if url is present in keywordlist
   if(urlLookup)
   {
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "URL lookup"
         << std::endl;
   }

      if(lookup)
      {
         obj = createObject(ossimString(lookup));
         reader = dynamic_cast<ossimImageHandler*> (obj.get());
         obj = 0;
         if(reader.valid())
         {
            if(reader->loadState(kwl, prefix) == false)
            {
               reader = 0;
            }
         }
      }
      if(!reader.valid())
      {
         if(ossimUrl(urlLookup).getProtocol().downcase().contains("jpip"))
         {
            reader = new ossimKakaduJpipHandler();
            if(reader->loadState(kwl, prefix) == false)
            {
               reader = 0;
            }
         }
      }
   }
   else if(filenameLookup)
   {
      ossimFilename local(filenameLookup);

     
      // check if the filename is a jpip url
      if(!ossimFilename(filenameLookup).exists()&&
         ossimUrl(filenameLookup).getProtocol().downcase().contains("jpip"))
      {
         reader = open(ossimFilename(filenameLookup));
      }
      else if(local.exists()&&(local.ext().downcase()=="jpip"))
      {
         // do local file keywordlist
         //
         ossimKeywordlist tempKwl;
         tempKwl.add(kwl, prefix, true);
         if(tempKwl.addFile(ossimFilename(filenameLookup)))
         {
            if(tempKwl.find("url"))
            {
               reader = open(tempKwl);
            }
         }
      }
   }
   else if(lookup)
   {
      obj = createObject(ossimString(lookup));
      reader = dynamic_cast<ossimImageHandler*> (obj.get());
      obj = 0;
      if(reader.valid())
      {
         if(reader->loadState(kwl, prefix) == false)
         {
            reader = 0;
         }
      }
   }
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimKakaduJpipHandlerFactory::open(kwl, prefix) DEBUG: leaving..."
         << std::endl;
   }
   
   return reader.release();
}

operator=()

void ossimKakaduJpipHandlerFactory::operator= ( const ossimKakaduJpipHandlerFactory &  )

protected

hidden from use copy constructor

Definition at line 225 of file ossimKakaduJpipHandlerFactory.cpp.

{}

---

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

• ossimKakaduJpipHandlerFactory.h
• ossimKakaduJpipHandlerFactory.cpp