---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	NO FRAMES
SUMMARY: NESTED |  FIELD | CONSTR |  METHOD	DETAIL:  FIELD | CONSTR |  METHOD

---

org.eclipse.jst.jsf.common.metadata.query
Class TaglibDomainMetaDataQueryHelper

java.lang.Object
  
org.eclipse.jst.jsf.common.metadata.query.TaglibDomainMetaDataQueryHelper

---

public final class TaglibDomainMetaDataQueryHelper
extends java.lang.Object

Helper class with static methods to simplify querying of a metadata model.

Steps for use:
1) Get the ITaglibDomainMetaDataModelContext using createMetaDataModelContext or createTagLibraryDomainMetaDataModelContext
2) Use appropriate getXXX methods using the ITaglibDomainMetaDataModelContext.

Provisional API - subject to change

See Also:

IResultSet, IEntityQueryVisitor, ITraitQueryVisitor, ITaglibDomainMetaDataModelContext, Model, Entity, Trait

---

Field Summary
static java.lang.String	TAGLIB_DOMAIN           Domain id for Tag library domain of metatdata

 

Method Summary
static  ITaglibDomainMetaDataModelContext	createMetaDataModelContext (IProject project, java.lang.String uri)           Convenience method for creating ITaglibDomainMetaDataModelContexts for TAGLIB_DOMAIN
static  IResultSet	getEntities ( Entity initialEntityContext, java.lang.String entityQuery, IEntityQueryVisitor entityKeyQueryVisitor)
static  IResultSet	getEntities ( ITaglibDomainMetaDataModelContext modelContext, java.lang.String entityKey, IEntityQueryVisitor visitor)
static  Entity	getEntity ( Entity initialEntityContext, java.lang.String entityKey)
static  Entity	getEntity ( ITaglibDomainMetaDataModelContext modelContext, java.lang.String entityKey)
static  Model	getModel ( ITaglibDomainMetaDataModelContext modelContext)
static javax.xml.namespace.QName	getQNameForTagEntity ( Entity tagEntity)
static  Trait	getTrait ( Entity entity, java.lang.String traitKey)
static  Trait	getTrait ( ITaglibDomainMetaDataModelContext modelContext, java.lang.String entityKey, java.lang.String traitKey)
static  IResultSet	getTraits ( Entity entity, java.lang.String traitKey, ITraitQueryVisitor traitQueryVisitor)

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

TAGLIB_DOMAIN

public static final java.lang.String TAGLIB_DOMAIN

Domain id for Tag library domain of metatdata

See Also:

Constant Field Values

Method Detail

createMetaDataModelContext

public static 
ITaglibDomainMetaDataModelContext createMetaDataModelContext(IProject project,
                                                                           java.lang.String uri)

Convenience method for creating ITaglibDomainMetaDataModelContexts for TAGLIB_DOMAIN

Parameters:

project -

uri -

Returns:

ITaglibDomainMetaDataModelContext

---

getModel

public static 
Model getModel(
ITaglibDomainMetaDataModelContext modelContext)

Parameters:

modelContext -

Returns:

Model object for given context. May return null if not located.

---

getEntity

public static 
Entity getEntity(
ITaglibDomainMetaDataModelContext modelContext,
                               java.lang.String entityKey)

Parameters:

modelContext -

entityKey - relative to root of the model

Returns:

the first entity match from the root of the model. May return null.

---

getEntities

public static 
IResultSet getEntities(
ITaglibDomainMetaDataModelContext modelContext,
                                     java.lang.String entityKey,
                                     
IEntityQueryVisitor visitor)

Parameters:

modelContext -

entityKey - relative to root of model

visitor -

Returns:

an IResultSet of entity objects

---

getTrait

public static 
Trait getTrait(
Entity entity,
                             java.lang.String traitKey)

Parameters:

entity -

traitKey -

Returns:

a trait or null for the given entity and traitKey using a SimpleEntityQueryVisitorImpl

---

getTraits

public static 
IResultSet getTraits(
Entity entity,
                                   java.lang.String traitKey,
                                   
ITraitQueryVisitor traitQueryVisitor)

Parameters:

entity -

traitKey -

traitQueryVisitor -

Returns:

an IResultSet of trait objects using supplied traitQueryVisitor. IResultSet should NOT be null.

---

getEntity

public static 
Entity getEntity(
Entity initialEntityContext,
                               java.lang.String entityKey)

Parameters:

initialEntityContext -

entityKey - relative to initial passed entity

Returns:

the first entity located by key using SimpleEntityQueryVisitorImpl

---

getEntities

public static 
IResultSet getEntities(
Entity initialEntityContext,
                                     java.lang.String entityQuery,
                                     
IEntityQueryVisitor entityKeyQueryVisitor)

Parameters:

initialEntityContext -

entityQuery - relative to initial passed entity

entityKeyQueryVisitor -

Returns:

IResultSet of entities located by key using entityQueryVisitor. IResultSet should NOT be null.

---

getTrait

public static 
Trait getTrait(
ITaglibDomainMetaDataModelContext modelContext,
                             java.lang.String entityKey,
                             java.lang.String traitKey)

Parameters:

modelContext -

entityKey -

traitKey -

Returns:

first trait found for entity and trait key starting from root of the model using SimpleMetaDataQueryImpl

---

getQNameForTagEntity

public static javax.xml.namespace.QName getQNameForTagEntity(
Entity tagEntity)

Parameters:

tagEntity -

Returns:

QName for tag entity

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	NO FRAMES
SUMMARY: NESTED |  FIELD | CONSTR |  METHOD	DETAIL:  FIELD | CONSTR |  METHOD

---