RetsMetadata Class Reference

RetsMetadata contains the API that is the main interface to all of the metadata. More...

#include <librets/RetsMetadata.h>

List of all members.

Public Member Functions

 RetsMetadata (MetadataFinderPtr finder)
 Creates metadata from a metadata by-level collector.
MetadataSystemGetSystem () const
 Returns the system metdata element.
MetadataForeignKeyList GetAllForeignKeys () const
 Retusn the foreign key metadata elements.
MetadataResourceList GetAllResources () const
 Returns all the resource metadata elements.
MetadataResourceGetResource (std::string resourceName) const
 Returns the metadata resource from its resource name.
MetadataClassList GetAllClasses (std::string resourceName) const
 Returns all metadata class elements for a specified resource.
MetadataClassGetClass (std::string resourceName, std::string className) const
 Returns the metadata class from its resource and class names.
MetadataTableList GetAllTables (MetadataClass *metadataClass) const
 Returns all metadata table elements for a specified metadata class.
MetadataTableList GetAllTables (std::string resourceName, std::string className) const
 Returns all metadata table elements with a resource and class name.
MetadataTableGetTable (std::string resourceName, std::string className, std::string tableName) const
 Returns the metadata class from its resource and class names.
MetadataLookupList GetAllLookups (std::string resourceName) const
 Returns all metadata lookup elements for a specified resource.
MetadataLookupGetLookup (std::string resourceName, std::string lookupName) const
 Returns a metadata lookup from a resource and lookup name.
MetadataLookupTypeList GetAllLookupTypes (std::string resourceName, std::string lookupName) const
 Returns all metadata lookup type element from its resource and lookup names.
MetadataLookupTypeList GetAllLookupTypes (MetadataLookup *metadataLookup) const
 Returns all metadata lookup type element for a lookup.
MetadataLookupTypeGetLookupType (std::string resourceName, std::string lookupName, std::string lookupValue) const
 Returns a metadata lookup from a resource name, lookup name, and lookup value.
MetadataObjectList GetAllObjects (std::string resourceName) const
 Returns a list of MetadataObjects from a resource name.
MetadataObjectList GetAllObjects (MetadataResource *metadataResource) const
 Returns a list of MetadataObjects from a resource.
MetadataSearchHelpGetSearchHelp (std::string resourceName, std::string searchHelpID) const
 Returns the requested SearchHelp given the resource name and searchHelpID.

Static Public Member Functions

static RetsMetadataCreateAndParse (istreamPtr inputStream, EncodingType encoding=RETS_XML_DEFAULT_ENCODING, ExceptionErrorHandler *handler=ExceptionErrorHandler::GetInstance())
 Create and return a Metadata object that parses the data from a given input stream.
static RetsMetadataCreateAndParse (BinaryData binaryData, EncodingType encoding=RETS_XML_DEFAULT_ENCODING, ExceptionErrorHandler *handler=ExceptionErrorHandler::GetInstance())
 Create and return a Metadata object that parses the data from a BinaryData object.
static public RetsMetadata CreateMetadataFromArray (byte[] buffer)
 Create and return a Metadata object that parses the data from a java byte array.


Detailed Description

RetsMetadata contains the API that is the main interface to all of the metadata.

Constructor & Destructor Documentation

RetsMetadata ( MetadataFinderPtr  finder  ) 

Creates metadata from a metadata by-level collector.


Member Function Documentation

static RetsMetadata* CreateAndParse ( BinaryData  binaryData,
EncodingType  encoding = RETS_XML_DEFAULT_ENCODING,
ExceptionErrorHandler handler = ExceptionErrorHandler::GetInstance() 
) [static]

Create and return a Metadata object that parses the data from a BinaryData object.

Parameters:
binaryData A BinaryData object from which the data will be injected into the parser.
encoding The data encoding type: one of RETS_XML_DEFAULT_ENCODING (default), RETS_XML_ISO_ENCODING or RETS_XML_UTF8_ENCODING
handler The Exception Error Handler
Returns:
The default metadata object.

static RetsMetadata* CreateAndParse ( istreamPtr  inputStream,
EncodingType  encoding = RETS_XML_DEFAULT_ENCODING,
ExceptionErrorHandler handler = ExceptionErrorHandler::GetInstance() 
) [static]

Create and return a Metadata object that parses the data from a given input stream.

Parameters:
inputStream A stream from which the data will be injected into the parser.
encoding The data encoding type: one of RETS_XML_DEFAULT_ENCODING (default), RETS_XML_ISO_ENCODING or RETS_XML_UTF8_ENCODING
handler The Exception Error Handler
Returns:
The default metadata object.

static public RetsMetadata CreateMetadataFromArray ( byte[]  buffer  )  [static]

Create and return a Metadata object that parses the data from a java byte array.

This API is for Java only.

Parameters:
buffer A Java byte array containing the raw RETS metadta.
Returns:
A RetsMetadata object with data parsed from the array.

MetadataClassList GetAllClasses ( std::string  resourceName  )  const

Returns all metadata class elements for a specified resource.

Parameters:
resourceName A resource name
Returns:
All metadata class elements for that resource

MetadataForeignKeyList GetAllForeignKeys (  )  const

Retusn the foreign key metadata elements.

Returns:
All the foreign key metadata elements

MetadataLookupList GetAllLookups ( std::string  resourceName  )  const

Returns all metadata lookup elements for a specified resource.

Parameters:
resourceName A resource name
Returns:
All lookups for that resource

MetadataLookupTypeList GetAllLookupTypes ( MetadataLookup metadataLookup  )  const

Returns all metadata lookup type element for a lookup.

Parameters:
metadataLookup A metadata lookup element
Returns:
All lookup types

MetadataLookupTypeList GetAllLookupTypes ( std::string  resourceName,
std::string  lookupName 
) const

Returns all metadata lookup type element from its resource and lookup names.

Parameters:
resourceName A resource name
lookupName A lookup name
Returns:
All lookup types

MetadataObjectList GetAllObjects ( MetadataResource metadataResource  )  const

Returns a list of MetadataObjects from a resource.

Parameters:
metadataResource a MetadataResource object

MetadataObjectList GetAllObjects ( std::string  resourceName  )  const

Returns a list of MetadataObjects from a resource name.

Parameters:
resourceName A resource name

MetadataResourceList GetAllResources (  )  const

Returns all the resource metadata elements.

Returns:
All the resource metadata elements

MetadataTableList GetAllTables ( std::string  resourceName,
std::string  className 
) const

Returns all metadata table elements with a resource and class name.

Parameters:
resourceName A resource name
className A class name
Returns:
A list of matching metadata tables

MetadataTableList GetAllTables ( MetadataClass metadataClass  )  const

Returns all metadata table elements for a specified metadata class.

Parameters:
metadataClass A metadata class element
Returns:
All metadata table elements

MetadataClass* GetClass ( std::string  resourceName,
std::string  className 
) const

Returns the metadata class from its resource and class names.

Parameters:
resourceName A resource name
className A class name
Returns:
A metadata class

MetadataLookup* GetLookup ( std::string  resourceName,
std::string  lookupName 
) const

Returns a metadata lookup from a resource and lookup name.

Parameters:
resourceName A resource name
lookupName A lookup name
Returns:
A metadata lookup

MetadataLookupType* GetLookupType ( std::string  resourceName,
std::string  lookupName,
std::string  lookupValue 
) const

Returns a metadata lookup from a resource name, lookup name, and lookup value.

Parameters:
resourceName A resource name
lookupName A lookup name
lookupValue A lookup value
Returns:
A metadata lookup type

MetadataResource* GetResource ( std::string  resourceName  )  const

Returns the metadata resource from its resource name.

Parameters:
resourceName A resource name
Returns:
A metadata class

MetadataSearchHelp* GetSearchHelp ( std::string  resourceName,
std::string  searchHelpID 
) const

Returns the requested SearchHelp given the resource name and searchHelpID.

Parameters:
resourceName A resource name
searchHelpID The search help ID
Returns:
A MetadataSearchHelp

MetadataSystem* GetSystem (  )  const

Returns the system metdata element.

Returns:
The system metadata element

MetadataTable* GetTable ( std::string  resourceName,
std::string  className,
std::string  tableName 
) const

Returns the metadata class from its resource and class names.

Parameters:
resourceName A resource name
className A class name
tableName A table name
Returns:
A metadata class


Generated by  doxygen