ODataFunctionImport class

Syntax

public class ODataFunctionImport extends ParserDocument, IODataFunctionImport

Members

All members of ODataFunctionImport, including inherited members.

Variables

Modifier and Type	Variable	Description
protected String	baseUrl

Constructors

Modifier and Type	Constructor	Description
public	ODataFunctionImport()
public	ODataFunctionImport(ParserDocument)
protected	ODataFunctionImport(int[], String[])

Methods

Modifier and Type	Method	Description
public String	getActionFor()	Returns The value of the appropriate OData attribute.
public String	getCollectionId()	Returns The value of the 'EntitySet' OData attribute.
public String	getEntitySet()	Returns The value of the 'EntitySet' OData attribute.
public String	getExecutionUrl(Map< String, String >)	Calculate the full execution URL for executing this Function Import according to the passed paramteres.
public String	getHTTPMethod()	Returns The value of the appropriate OData attribute.
public List< String >	getInputParameterNames()	Returns The list of the appropriate OData element with 'In' or 'InOut' attribute value.
public String	getName()	Returns The value of the appropriate OData attribute.
public List< String >	getOutputParameterNames()	Returns The list of the appropriate OData element with 'Out' or 'InOut' attribute value.
public List< IODataParameter >	getParameters()	Returns The list of the appropriate OData element.
public String	getReturnType()	Returns The value of the appropriate OData attribute.
public RETURNTYPE_ENUM	getReturnTypeEnum()	Returns The return type of this Function Import OData document.
public void	read(BufferedReader)
public void	setBaseUrl(String)
public void	write(BufferedWriter)

Inherited members from ParserDocument

Modifier and Type	Member	Description
static transient final String	ANY_STRING
static transient final int	ATTRIBUTE_ID
static transient final String	ATTRIBUTE_STRING
public ParserDocument	clone()	Creates a copy of this object.
protected Map< String, String >	extensions
public String	getAttribute(String...)	Returns the value of the first attribute with the given route.
public List< String >	getAttributes(String...)	Returns all the values of attributes with the given route.
protected int	getAttributesEndPosition(int[], int, int)
public Map< String, String >	getChildAttributeMap(String...)	Returns all the name-value pairs of attributes contained by the element with the given route.
public List< String >	getChildAttributes(String...)	Returns all the values of attributes contained by the element with the given route.
public List< IParserDocument >	getChildDocuments(String...)	Returns the elements contained by the element with the given route.
public List< IParserDocument >	getChildDocumentsWithAttribute(String, String, String...)	Returns the elements contained by the element with the given route and having the given attribute with the given value.
public List< IParserDocument >	getChildDocumentsWithAttribute(String, String, boolean, String...)	Returns the elements contained by the element with the given route and having the given attribute with the given value.
public ParserDocument	getDocument(String...)	Returns the first element with the given route.
protected List< int[]>	getDocumentPositions(String[], int, boolean, boolean)
public List< IParserDocument >	getDocuments(String...)	Returns all the elements with the given route.
public List< IParserDocument >	getDocumentsWithAttribute(String, String, String...)	Returns the elements with the given route that contains the given attribute with the given value.
public List< IParserDocument >	getDocumentsWithAttribute(String, String, boolean, String...)	Returns the elements with the given route that contains the given attribute with the given value.
public IParserDocument	getDocumentWithAttribute(String, String, String...)	Returns the first element with the given route that contains the given attribute with the given value.
public IParserDocument	getDocumentWithAttribute(String, String, boolean, String...)	Returns the first element with the given route that contains the given attribute with the given value.
public String	getElementName()	Returns The name of the root element of this document.
public String	getExtension(String)
public String	getFunctionImportComplexPropertyValue(String...)
static int	getNameId(String, boolean, boolean)
public static List< String >	getNameMap()
public static String	getPrefix(String)
public String	getPrefixForUri(String)	Returns the appropriate name-space prefix for the given XML name-space URI.
public static Map< String, String >	getPrefixMapping()
protected List< Integer >	getStringPositions(String[], int, boolean, boolean)
public String[]	getStrings()	Returns all the string values contained by this document.
public String	getValue(String...)	Returns the value of the first element with the given route.
public List< String >	getValues(String...)	Returns all the values of elements with the given route.
protected int[]	insertRoutePositions(int[], int, int[])
protected void	insertRoutesPositions(int, int[])
protected void	insertStringsPositions(int, String[])
protected String[]	insertStringsPositions(String[], int, String[])
boolean	isComplexEntity
boolean	isJson
protected boolean	isMatched(String, String)
static List< String >	nameMap
	ParserDocument()
	ParserDocument(boolean)
public	ParserDocument(String)
public	ParserDocument(ParserDocument)
protected	ParserDocument(int[], String[])
protected	ParserDocument(String, boolean)
static Map< String, String >	prefixMapping
public void	putAttribute(String, String...)	Sets the value of the attribute with the given route If attribute does not exist it will be created as well as all other non existing elements in the route.
public void	putDocument(IParserDocument, String...)	Insert the document under the element with the given route inserted document will be placed before already existing documents with the same route name under All missing elements from the route will be created.
public void	putExtension(String, String)
protected void	putString(int, String, int, String...)
public void	putValue(String, String...)	Sets the value of the first element with the given route.
public void	readExternal(ObjectInput)
public static void	readNameMap(BufferedReader)
public boolean	removeAttribute(String...)	Removes first element with the given route.
public boolean	removeAttributes(String...)	Removes all the attribute with the given route.
public boolean	removeDocument(String...)	Removes first element with the given route For removing multiple element use setDocuemtns with null arguments.
public void	removeExtension(String)
protected void	removeRoutesPositions(int, int)
protected int[]	removeRoutesPositions(int[], int, int)
protected boolean	removeString(String...)
protected boolean	removeStrings(String...)
protected void	removeStringsPositions(int, int)
protected String[]	removeStringsPositions(String[], int, int)
protected int	replaceRoutesPositions(int, int, int[])
protected int[]	replaceRoutesPositions(int[], int, int, int[])
protected int	replaceStringsPositions(int, int, String[])
protected String[]	replaceStringsPositions(String[], int, int, String[])
public static String	resolveUrl(String, String)
protected int[]	routes
public void	setAttribute(String, String...)
public void	setAttributes(List< String >, String...)	Sets all the values of the attributes with the given route Values will be paired to attributes in order Attributes with greater or equals index than size of new values will be untouched Attributes paired with null values will be removed.
public boolean	setDocument(IParserDocument, String...)
public void	setDocuments(List< IParserDocument >, String...)	Replaces all the elements with the given route Documents will be paired to elements in order Elements with greater or equals index than size of new elements will be untouched Element paired with null will be removed.
public void	setElementName(String, String...)	Sets the name of the root element with the given route Use empty route for setting root name of this document.
public static void	setNameMap(List< String >)
public static void	setPrefixMapping(Map< String, String >)
protected void	setString(String, String...)
protected void	setStrings(List< String >, String...)
public void	setValue(String, String...)
public void	setValues(List< String >, String...)	Sets all the values of the elements with the given rout Values will be paired to elements in order Elements with greater or equals index than size of new values will be untouched Null values will be treated as empty strings.
protected String[]	strings
public String	toXMLString()	Returns the XML string representation of this object.
protected static final String	URL_PROTOCOL_PREFIX
static transient final int	VALUE_ID
static transient final String	VALUE_STRING
public void	writeExternal(ObjectOutput)
public static void	writeNameMap(BufferedWriter)

Inherited members from IParserDocument

Modifier and Type	Member	Description
public static final String	ATTRIBUTE_ETAG	Name of the appropriate OData element.
public static final String	ATTRIBUTE_VALUEPREFIX_EDMTYPE	Value prefix for EDM Type type values.
public static Map< String, String >	DEFAULT_PREFIXMAPPING	The default XML Namespace-to-Prefix mapping used for building XMLS.
public static final String[]	EDMDATETIME_PATTERNS	Possible EDM DateTime patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String[]	EDMDATETIMEOFFSET_PATTERNS	Possible EDM TimeOffset patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String	EDMTIME_PATTERN	EDM Time pattern.
public static String	ELEMENT_FEED	Name of the appropriate OData element.
public static final String	ELEMENT_ID	Name of the appropriate OData element.
public static final String	ROOT_DOCUMENT_NAME	The default root element name for a new document.
public static final String	XMLNS_APPLICATION_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String	XMLNS_ATOM_URI	Constant for XMLNS URI: http://www.w3.org/2005/Atom.
public static final String	XMLNS_DATASERVICES_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String	XMLNS_EDM_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/05/edm.
public static final String	XMLNS_EDMX_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/06/edmx.
public static final String	XMLNS_GENERICPLAYER_URI	Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData/GenericPlayer.
public static final String	XMLNS_METADATA_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices/metadata.
public static final String	XMLNS_SAP_URI	Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData.

Inherited members from IPersistable

Modifier and Type	Member	Description
public void	read(BufferedReader)
public void	write(BufferedWriter)

Inherited members from IODataFunctionImport

Modifier and Type	Member	Description
public static final String	ATTRIBUTE_ACTION_FOR	Name of the appropriate OData attribute.
public static final String	ATTRIBUTE_ENTITYSET	Name of the appropriate OData attribute.
public static final String	ATTRIBUTE_HTTPMETHOD	Name of the appropriate OData attribute.
public static final String	ATTRIBUTE_NAME	Name of the appropriate OData attribute.
public static final String	ATTRIBUTE_RETURNTYPE	Name of the appropriate OData attribute.
public static final String	ELEMENT_FUNCTIONALIMPORT	Name of the appropriate OData element.
public static final String	ELEMENT_PARAMETER	Name of the appropriate OData element.

Inherited members from IParserDocument

Modifier and Type	Member	Description
public static final String	ATTRIBUTE_ETAG	Name of the appropriate OData element.
public static final String	ATTRIBUTE_VALUEPREFIX_EDMTYPE	Value prefix for EDM Type type values.
public abstract IParserDocument	clone()	Creates a copy of this object.
public static Map< String, String >	DEFAULT_PREFIXMAPPING	The default XML Namespace-to-Prefix mapping used for building XMLS.
public static final String[]	EDMDATETIME_PATTERNS	Possible EDM DateTime patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String[]	EDMDATETIMEOFFSET_PATTERNS	Possible EDM TimeOffset patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String	EDMTIME_PATTERN	EDM Time pattern.
public static String	ELEMENT_FEED	Name of the appropriate OData element.
public static final String	ELEMENT_ID	Name of the appropriate OData element.
public abstract String	getAttribute(String...)	Returns the value of the first attribute with the given route.
public abstract List< String >	getAttributes(String...)	Returns all the values of attributes with the given route.
public abstract Map< String, String >	getChildAttributeMap(String...)	Returns all the name-value pairs of attributes contained by the element with the given route.
public abstract List< String >	getChildAttributes(String...)	Returns all the values of attributes contained by the element with the given route.
public abstract List< IParserDocument >	getChildDocuments(String...)	Returns the elements contained by the element with the given route.
public abstract List< IParserDocument >	getChildDocumentsWithAttribute(String, String, String...)	Returns the elements contained by the element with the given route and having the given attribute with the given value.
public abstract List< IParserDocument >	getChildDocumentsWithAttribute(String, String, boolean, String...)	Returns the elements contained by the element with the given route and having the given attribute with the given value.
public abstract IParserDocument	getDocument(String...)	Returns the first element with the given route.
public abstract List< IParserDocument >	getDocuments(String...)	Returns all the elements with the given route.
public abstract List< IParserDocument >	getDocumentsWithAttribute(String, String, String...)	Returns the elements with the given route that contains the given attribute with the given value.
public abstract List< IParserDocument >	getDocumentsWithAttribute(String, String, boolean, String...)	Returns the elements with the given route that contains the given attribute with the given value.
public abstract IParserDocument	getDocumentWithAttribute(String, String, String...)	Returns the first element with the given route that contains the given attribute with the given value.
public abstract IParserDocument	getDocumentWithAttribute(String, String, boolean, String...)	Returns the first element with the given route that contains the given attribute with the given value.
public abstract String	getElementName()	Returns The name of the root element of this document.
public abstract String	getFunctionImportComplexPropertyValue(String...)
public abstract String	getPrefixForUri(String)	Returns the appropriate name-space prefix for the given XML name-space URI.
public abstract String[]	getStrings()	Returns all the string values contained by this document.
public abstract String	getValue(String...)	Returns the value of the first element with the given route.
public abstract List< String >	getValues(String...)	Returns all the values of elements with the given route.
public abstract void	putAttribute(String, String...)	Sets the value of the attribute with the given route If attribute does not exist it will be created as well as all other non existing elements in the route.
public abstract void	putDocument(IParserDocument, String...)	Insert the document under the element with the given route inserted document will be placed before already existing documents with the same route name under All missing elements from the route will be created.
public abstract void	putValue(String, String...)	Sets the value of the first element with the given route.
public abstract boolean	removeAttribute(String...)	Removes first element with the given route.
public abstract boolean	removeAttributes(String...)	Removes all the attribute with the given route.
public abstract boolean	removeDocument(String...)	Removes first element with the given route For removing multiple element use setDocuemtns with null arguments.
public static final String	ROOT_DOCUMENT_NAME	The default root element name for a new document.
public abstract void	setAttributes(List< String >, String...)	Sets all the values of the attributes with the given route Values will be paired to attributes in order Attributes with greater or equals index than size of new values will be untouched Attributes paired with null values will be removed.
public abstract void	setDocuments(List< IParserDocument >, String...)	Replaces all the elements with the given route Documents will be paired to elements in order Elements with greater or equals index than size of new elements will be untouched Element paired with null will be removed.
public abstract void	setElementName(String, String...)	Sets the name of the root element with the given route Use empty route for setting root name of this document.
public abstract void	setValues(List< String >, String...)	Sets all the values of the elements with the given rout Values will be paired to elements in order Elements with greater or equals index than size of new values will be untouched Null values will be treated as empty strings.
public abstract String	toXMLString()	Returns the XML string representation of this object.
public static final String	XMLNS_APPLICATION_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String	XMLNS_ATOM_URI	Constant for XMLNS URI: http://www.w3.org/2005/Atom.
public static final String	XMLNS_DATASERVICES_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String	XMLNS_EDM_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/05/edm.
public static final String	XMLNS_EDMX_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/06/edmx.
public static final String	XMLNS_GENERICPLAYER_URI	Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData/GenericPlayer.
public static final String	XMLNS_METADATA_URI	Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices/metadata.
public static final String	XMLNS_SAP_URI	Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData.

Inherited members from IPersistable

Modifier and Type	Member	Description
public void	read(BufferedReader)
public void	write(BufferedWriter)