Class RealizationQueryParameters

Inheritance

object

RealizationQueryParameters

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Xareus.Relations

Assembly: Xareus.Relations.dll

Syntax

[Serializable]
[DataContract(Name = "RealizationQueryParameters", Namespace = "http://www.insa-rennes.fr/Xareus.Relations")]
public class RealizationQueryParameters

Constructors

RealizationQueryParameters()

RealizationQueryParameters class constructor

Declaration

public RealizationQueryParameters()

RealizationQueryParameters(HashSet<IObject>, HashSet<IObjectType>, HashSet<IObject>, HashSet<IRelation>)

Constructor

Declaration

public RealizationQueryParameters(HashSet<IObject> mandatoryObjects, HashSet<IObjectType> mandatoryTypes = null, HashSet<IObject> optionalObjects = null, HashSet<IRelation> relationsToUse = null)

Parameters

Type	Name	Description
HashSet<IObject>	mandatoryObjects
HashSet<IObjectType>	mandatoryTypes
HashSet<IObject>	optionalObjects
HashSet<IRelation>	relationsToUse

RealizationQueryParameters(HashSet<IObject>, HashSet<IObject>, HashSet<IRelation>)

Constructor

Declaration

public RealizationQueryParameters(HashSet<IObject> mandatoryObjects, HashSet<IObject> optionalObjects = null, HashSet<IRelation> relationsToUse = null)

Parameters

Type	Name	Description
HashSet<IObject>	mandatoryObjects
HashSet<IObject>	optionalObjects
HashSet<IRelation>	relationsToUse

RealizationQueryParameters(IEnumerable<IObject>, IEnumerable<IObjectType>, IEnumerable<IObject>, IEnumerable<IRelation>)

Constructor

Declaration

public RealizationQueryParameters(IEnumerable<IObject> mandatoryObjects, IEnumerable<IObjectType> mandatoryTypes = null, IEnumerable<IObject> optionalObjects = null, IEnumerable<IRelation> relationsToUse = null)

Parameters

Type	Name	Description
IEnumerable<IObject>	mandatoryObjects
IEnumerable<IObjectType>	mandatoryTypes
IEnumerable<IObject>	optionalObjects
IEnumerable<IRelation>	relationsToUse

RealizationQueryParameters(IEnumerable<IObject>, IEnumerable<IObject>, IEnumerable<IRelation>)

Constructor

Declaration

public RealizationQueryParameters(IEnumerable<IObject> mandatoryObjects, IEnumerable<IObject> optionalObjects = null, IEnumerable<IRelation> relationsToUse = null)

Parameters

Type	Name	Description
IEnumerable<IObject>	mandatoryObjects
IEnumerable<IObject>	optionalObjects
IEnumerable<IRelation>	relationsToUse

Properties

MandatoryObjects

Objects that MUST be present in the resulting realizations

Declaration

[DataMember]
public HashSet<IObject> MandatoryObjects { get; set; }

Property Value

Type	Description
HashSet<IObject>

MandatoryTypes

Types that MUST be present in the resulting realizations

Declaration

[DataMember]
public HashSet<IObjectType> MandatoryTypes { get; set; }

Property Value

Type	Description
HashSet<IObjectType>

OptionalObjects

Objects that CAN be present. Any object that is not specified here or in MandatoryObjects WILL NOT be present in the resulting realizations.

Declaration

[DataMember]
public HashSet<IObject> OptionalObjects { get; set; }

Property Value

Type	Description
HashSet<IObject>

RelationsToUse

Relations to consider for the query.

Declaration

[DataMember]
public HashSet<IRelation> RelationsToUse { get; set; }

Property Value

Type	Description
HashSet<IRelation>

Methods

Deserialize(string)

Declaration

public static RealizationQueryParameters Deserialize(string xml)

Parameters

Type	Name	Description
string	xml

Returns

Type	Description
RealizationQueryParameters

Deserialize(string, out RealizationQueryParameters)

Declaration

public static bool Deserialize(string xml, out RealizationQueryParameters obj)

Parameters

Type	Name	Description
string	xml
RealizationQueryParameters	obj

Returns

Type	Description
bool

Deserialize(string, out RealizationQueryParameters, out Exception)

Deserializes workflow markup into an RealizationQueryParameters object

Declaration

public static bool Deserialize(string xml, out RealizationQueryParameters obj, out Exception exception)

Parameters

Type	Name	Description
string	xml	string workflow markup to deserialize
RealizationQueryParameters	obj	Output RealizationQueryParameters object
Exception	exception	output Exception value if deserialize failed

Returns

Type	Description
bool	true if this XmlSerializer can deserialize the object; otherwise, false

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

GetQueryAllOptional(IEngine)

Get a query to use all registered objects as optional

Declaration

public static RealizationQueryParameters GetQueryAllOptional(IEngine engine)

Parameters

Type	Name	Description
IEngine	engine

Returns

Type	Description
RealizationQueryParameters

GetQueryAllOptionalAllRelation(IEngine)

Get a query to use all registered objects as optional and all registered relation as relations to use

Declaration

public static RealizationQueryParameters GetQueryAllOptionalAllRelation(IEngine engine)

Parameters

Type	Name	Description
IEngine	engine

Returns

Type	Description
RealizationQueryParameters

GetQueryAllRelation(IEngine)

Get a query to use all registered relation as relations to use

Declaration

public static RealizationQueryParameters GetQueryAllRelation(IEngine engine)

Parameters

Type	Name	Description
IEngine	engine

Returns

Type	Description
RealizationQueryParameters

LoadFromFile(string)

Declaration

public static RealizationQueryParameters LoadFromFile(string fileName)

Parameters

Type	Name	Description
string	fileName

Returns

Type	Description
RealizationQueryParameters

LoadFromFile(string, out RealizationQueryParameters)

Declaration

public static bool LoadFromFile(string fileName, out RealizationQueryParameters obj)

Parameters

Type	Name	Description
string	fileName
RealizationQueryParameters	obj

Returns

Type	Description
bool

LoadFromFile(string, out RealizationQueryParameters, out Exception)

Deserializes XML markup from file into an RealizationQueryParameters object

Declaration

public static bool LoadFromFile(string fileName, out RealizationQueryParameters obj, out Exception exception)

Parameters

Type	Name	Description
string	fileName	string xml file to load and deserialize
RealizationQueryParameters	obj	Output RealizationQueryParameters object
Exception	exception	output Exception value if deserialize failed

Returns

Type	Description
bool	true if this XmlSerializer can deserialize the object; otherwise, false

SaveToFile(string)

Declaration

public virtual void SaveToFile(string fileName)

Parameters

Type	Name	Description
string	fileName

SaveToFile(string, out Exception)

Serializes current RealizationQueryParameters object into file

Declaration

public virtual bool SaveToFile(string fileName, out Exception exception)

Parameters

Type	Name	Description
string	fileName	full path of output XML file
Exception	exception	output Exception value if failed

Returns

Type	Description
bool	true if can serialize and save into file; otherwise, false

Serialize()

Serializes current RealizationQueryParameters object into an XML document

Declaration

public virtual string Serialize()

Returns

Type	Description
string	string XML value

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()