#include <librets/RetsMetadata.h>
Public Member Functions | |
| RetsMetadata (MetadataFinderPtr finder) | |
| Creates metadata from a metadata by-level collector. | |
| MetadataSystem * | GetSystem () const |
| Returns the system metdata element. | |
| MetadataForeignKeyList | GetAllForeignKeys () const |
| Retusn the foreign key metadata elements. | |
| MetadataResourceList | GetAllResources () const |
| Returns all the resource metadata elements. | |
| MetadataResource * | GetResource (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. | |
| MetadataClass * | GetClass (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. | |
| MetadataTable * | GetTable (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. | |
| MetadataLookup * | GetLookup (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. | |
| 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. | |
| 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. | |
| MetadataSearchHelp * | GetSearchHelp (std::string resourceName, std::string searchHelpID) const |
| Returns the requested SearchHelp given the resource name and searchHelpID. | |
Static Public Member Functions | |
| static RetsMetadata * | CreateAndParse (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 RetsMetadata * | CreateAndParse (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. | |
| RetsMetadata | ( | MetadataFinderPtr | finder | ) |
Creates metadata from a metadata by-level collector.
| 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.
| 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 |
| 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.
| 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 |
| 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.
| buffer | A Java byte array containing the raw RETS metadta. |
| MetadataClassList GetAllClasses | ( | std::string | resourceName | ) | const |
Returns all metadata class elements for a specified resource.
| resourceName | A resource name |
| MetadataForeignKeyList GetAllForeignKeys | ( | ) | const |
Retusn the foreign key metadata elements.
| MetadataLookupList GetAllLookups | ( | std::string | resourceName | ) | const |
Returns all metadata lookup elements for a specified resource.
| resourceName | A resource name |
| MetadataLookupTypeList GetAllLookupTypes | ( | MetadataLookup * | metadataLookup | ) | const |
Returns all metadata lookup type element for a lookup.
| metadataLookup | A metadata lookup element |
| MetadataLookupTypeList GetAllLookupTypes | ( | std::string | resourceName, | |
| std::string | lookupName | |||
| ) | const |
Returns all metadata lookup type element from its resource and lookup names.
| resourceName | A resource name | |
| lookupName | A lookup name |
| MetadataObjectList GetAllObjects | ( | MetadataResource * | metadataResource | ) | const |
Returns a list of MetadataObjects from a resource.
| metadataResource | a MetadataResource object |
| MetadataObjectList GetAllObjects | ( | std::string | resourceName | ) | const |
Returns a list of MetadataObjects from a resource name.
| resourceName | A resource name |
| MetadataResourceList GetAllResources | ( | ) | const |
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.
| resourceName | A resource name | |
| className | A class name |
| MetadataTableList GetAllTables | ( | MetadataClass * | metadataClass | ) | const |
Returns all metadata table elements for a specified metadata class.
| metadataClass | A metadata class element |
| MetadataClass* GetClass | ( | std::string | resourceName, | |
| std::string | className | |||
| ) | const |
Returns the metadata class from its resource and class names.
| resourceName | A resource name | |
| className | A class name |
| MetadataLookup* GetLookup | ( | std::string | resourceName, | |
| std::string | lookupName | |||
| ) | const |
Returns a metadata lookup from a resource and lookup name.
| resourceName | A resource name | |
| lookupName | A lookup name |
| 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.
| resourceName | A resource name | |
| lookupName | A lookup name | |
| lookupValue | A lookup value |
| MetadataResource* GetResource | ( | std::string | resourceName | ) | const |
Returns the metadata resource from its resource name.
| resourceName | A resource name |
| MetadataSearchHelp* GetSearchHelp | ( | std::string | resourceName, | |
| std::string | searchHelpID | |||
| ) | const |
Returns the requested SearchHelp given the resource name and searchHelpID.
| resourceName | A resource name | |
| searchHelpID | The search help ID |
| MetadataSystem* GetSystem | ( | ) | const |
Returns the system metdata element.
| MetadataTable* GetTable | ( | std::string | resourceName, | |
| std::string | className, | |||
| std::string | tableName | |||
| ) | const |
Returns the metadata class from its resource and class names.
| resourceName | A resource name | |
| className | A class name | |
| tableName | A table name |