public class SavedBundle
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_CATEGORY
Xml attribute name for the category
|
static java.lang.String |
ATTR_NAME
Xml attribute name for the name
|
static java.lang.String |
ATTR_TYPE
xml attr
|
static java.lang.String |
ATTR_URL
Xml attribute name for the url
|
static java.lang.String |
TAG_BUNDLE
Xml tag name for the bundle element
|
static java.lang.String |
TAG_BUNDLES
Xml tag name for the bundles element
|
static int |
TYPE_DATA
The type to specify the data
|
static int |
TYPE_DISPLAY
The type to specify the display templates
|
static int |
TYPE_FAVORITE
The type to specify the "Favorites" bundles
|
static java.lang.String |
VALUE_DATA
type of saved bundle
|
static java.lang.String |
VALUE_DISPLAY
type of saved bundle
|
static java.lang.String |
VALUE_FAVORITE
type of saved bundle
|
Constructor and Description |
---|
SavedBundle(org.w3c.dom.Element node,
java.lang.String dirRoot,
IdvResourceManager resourceManager,
boolean local)
Create the saved bundle object
|
SavedBundle(java.lang.String url,
java.lang.String name,
java.util.List categories)
Create the saved bundle object
|
SavedBundle(java.lang.String url,
java.lang.String name,
java.util.List categories,
boolean local)
ctor
|
SavedBundle(java.lang.String url,
java.lang.String name,
java.util.List categories,
java.lang.Object prototype,
boolean local)
Create the saved bundle object
|
SavedBundle(java.lang.String url,
java.lang.String name,
java.util.List categories,
java.lang.Object prototype,
boolean local,
int type)
_more_
|
Modifier and Type | Method and Description |
---|---|
java.util.List |
getCategories()
Get the Category property.
|
java.lang.String |
getCategorizedName()
Get the name to use with the categories as a prefix
|
java.lang.String |
getLabel()
Full label
|
boolean |
getLocal()
Get the Local property.
|
java.lang.String |
getName()
Get the Name property.
|
java.lang.Object |
getPrototype()
Get the prototype - may be null.
|
int |
getType()
Get the Type property.
|
java.lang.String |
getUrl()
Get the Url property.
|
static java.util.List<SavedBundle> |
processBundleXml(org.w3c.dom.Element root,
java.lang.String dirRoot,
IdvResourceManager resourceManager,
boolean local)
Utility that created a list of SavedBundle objects
from the document at the given xml path
|
void |
setCategories(java.util.List value)
Set the Category property.
|
void |
setLocal(boolean value)
Set the Local property.
|
void |
setName(java.lang.String value)
Set the Name property.
|
void |
setType(int value)
Set the Type property.
|
protected void |
setUniquePrefix(java.lang.String p)
set the unique prefix
|
void |
setUrl(java.lang.String value)
Set the Url property.
|
java.lang.String |
toString()
Override toString.
|
void |
toXml(org.w3c.dom.Document doc,
org.w3c.dom.Element root)
Write out the xml that defines this SavedBundle.
|
void |
toXml(org.w3c.dom.Document doc,
org.w3c.dom.Element root,
boolean includeCategoryInUrl)
Write out the xml that defines this SavedBundle.
|
public static final int TYPE_FAVORITE
public static final int TYPE_DISPLAY
public static final int TYPE_DATA
public static final java.lang.String VALUE_FAVORITE
public static final java.lang.String VALUE_DATA
public static final java.lang.String VALUE_DISPLAY
public static final java.lang.String TAG_BUNDLES
public static final java.lang.String TAG_BUNDLE
public static final java.lang.String ATTR_URL
public static final java.lang.String ATTR_NAME
public static final java.lang.String ATTR_CATEGORY
public static final java.lang.String ATTR_TYPE
public SavedBundle(org.w3c.dom.Element node, java.lang.String dirRoot, IdvResourceManager resourceManager, boolean local)
node
- The xml node that defines this objectdirRoot
- The directory rootresourceManager
- Reference to the resource manager so we add
the sitepath, etc., macros into the urllocal
- Is it a local filepublic SavedBundle(java.lang.String url, java.lang.String name, java.util.List categories)
url
- The urlname
- The namecategories
- List of (String) categories.public SavedBundle(java.lang.String url, java.lang.String name, java.util.List categories, boolean local)
url
- the url pathname
- namecategories
- categorieslocal
- is it a local filepublic SavedBundle(java.lang.String url, java.lang.String name, java.util.List categories, java.lang.Object prototype, boolean local)
url
- The urlname
- The namecategories
- List of (String) categories.prototype
- The object this bundle represents - may be null.local
- is it a local filepublic SavedBundle(java.lang.String url, java.lang.String name, java.util.List categories, java.lang.Object prototype, boolean local, int type)
url
- _more_name
- _more_categories
- _more_prototype
- _more_local
- _more_type
- _more_public void toXml(org.w3c.dom.Document doc, org.w3c.dom.Element root)
doc
- The document to create the xml withroot
- The xml rootpublic void toXml(org.w3c.dom.Document doc, org.w3c.dom.Element root, boolean includeCategoryInUrl)
doc
- The document to create the xml withroot
- The xml rootincludeCategoryInUrl
- Should the category be included in the urlprotected void setUniquePrefix(java.lang.String p)
p
- prefixpublic java.lang.String getCategorizedName()
public static java.util.List<SavedBundle> processBundleXml(org.w3c.dom.Element root, java.lang.String dirRoot, IdvResourceManager resourceManager, boolean local)
root
- Root of the bundles xml doc.dirRoot
- The directory rootresourceManager
- The resource managerlocal
- is it a local filepublic void setUrl(java.lang.String value)
value
- The new value for Urlpublic java.lang.String getUrl()
public void setName(java.lang.String value)
value
- The new value for Namepublic java.lang.String getName()
public void setCategories(java.util.List value)
value
- The new value for Categorypublic java.util.List getCategories()
public java.lang.Object getPrototype()
public java.lang.String getLabel()
public java.lang.String toString()
toString
in class java.lang.Object
public void setType(int value)
value
- The new value for Typepublic int getType()
public void setLocal(boolean value)
value
- The new value for Localpublic boolean getLocal()