/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
*
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_rdf_XDocumentRepository_idl__
#define __com_sun_star_rdf_XDocumentRepository_idl__
#ifndef __com_sun_star_beans_Pair_idl__
#include
#endif
#ifndef __com_sun_star_rdf_XMetadatable_idl__
#include
#endif
#ifndef __com_sun_star_rdf_XRepository_idl__
#include
#endif
//=============================================================================
module com { module sun { module star { module rdf {
//=============================================================================
/** extends XRepository with document-specific functionality.
This subclass of XRepository provides some methods which
only make sense for repositories that are attached to a document.
For example, the methods allow for manipulating in-content metadata,
which is stored as RDFa.
@since OOo 3.2
@see XRepositorySupplier
@see XDocumentMetadataAccess
*/
interface XDocumentRepository : XRepository
{
//-------------------------------------------------------------------------
/** update the RDFa statement(s) that correspond to an ODF element in the
repository.
This method will do the following steps:
- Remove all previously set RDFa statements for the Object parameter
from the repository
- If the RDFaContent parameter is the empty string,
for every Predicate in the given list of Predicates,
add the following RDF statement to an unspecified named graph:
Subject Predicate
XLiteral(Object->getText()^^RDFaDatatype)
- If the RDFaContent parameter is not the empty string,
for every Predicate in the given list of Predicates,
add the following RDF statement to an unspecified named graph:
-
Subject Predicate XLiteral(RDFaContent^^RDFaDatatype)
RDFa statements are handled specially because they are not logically
part of any named graph in the repository.
Also, they have rather unusual semantics;
just using XNamedGraph::addStatement would be
ambiguous:
if the object is a XMetadatable, do we insert
the object itself (URI) or its literal content (RDFa)?
@param Subject
the subject of the RDF triple(s).
@param Predicates
the predicates of the RDF triple(s).
@param Object
the object of the RDF triple(s) is the text content of this
parameter.
@param RDFaContent
the rdfa:content
attribute (may be the empty
string).
@param RDFaDatatype
the rdfa:datatype
attribute (may be )
@throws com::sun::star::lang::IllegalArgumentException
if any parameter is , Predicates is empty,
or Object is of a type that can not have RDFa metadata attached.
@throws RepositoryException
if an error occurs when accessing the repository.
*/
void setStatementRDFa(
[in] XResource Subject,
[in] sequence Predicates,
[in] XMetadatable Object,
[in] string RDFaContent,
[in] XURI RDFaDatatype)
raises( com::sun::star::lang::IllegalArgumentException,
RepositoryException );
//-------------------------------------------------------------------------
/** remove the RDFa statement(s) that correspond to an ODF element from the
repository.
RDFa statements are handled specially because they are not logically
part of any graph.
@param Element
the element whose RDFa statement(s) should be removed
@throws com::sun::star::lang::IllegalArgumentException
if the given Element is , or of a type that can not have
RDFa metadata attached.
@throws RepositoryException
if an error occurs when accessing the repository.
*/
void removeStatementRDFa([in] XMetadatable Element)
raises( com::sun::star::lang::IllegalArgumentException,
RepositoryException );
//-------------------------------------------------------------------------
/** find the RDFa statement(s) associated with an ODF element.
@param Element
the ODF element for which RDFa statements should be found
@returns
- if the element has no RDFa meta-data attributes:
the empty sequence.
- if the element has RDFa meta-data attributes:
- a sequence with the RDFa-statements corresponding to the
attributes.
- a flag indicating whether there is a xhtml:content
attribute.
@throws com::sun::star::lang::IllegalArgumentException
if the given Element is , or of a type that can not have
RDFa metadata attached.
@throws RepositoryException
if an error occurs when accessing the repository.
@see Statement
*/
com::sun::star::beans::Pair< sequence, boolean >
getStatementRDFa([in] XMetadatable Element)
raises( com::sun::star::lang::IllegalArgumentException,
RepositoryException );
//-------------------------------------------------------------------------
/** gets matching RDFa statements from the repository.
This method exists because RDFa statements are not part of any named
graph, and thus they cannot be enumerated with
XNamedGraph::getStatements.
Any parameter may be , which acts as a wildcard.
For example, to get all statements about myURI:
getStatementsRDFa(myURI, null, null)
@param Subject
the subject of the RDF triple.
@param Predicate
the predicate of the RDF triple.
@param Object
the object of the RDF triple.
@returns
an iterator over all RDFa statements in the repository that match
the parameters, represented as an
enumeration of Statement
@throws RepositoryException
if an error occurs when accessing the repository.
@see Statement
@see XRepository::getStatements
@see XNamedGraph::getStatements
*/
com::sun::star::container::XEnumeration/**/ getStatementsRDFa(
[in] XResource Subject,
[in] XURI Predicate,
[in] XNode Object)
raises( RepositoryException );
};
//=============================================================================
}; }; }; };
#endif